Home | History | Annotate | Download | only in docs
      1 #Topic FILEStream
      2 #Alias FILEStream_Reference ##
      3 
      4 #Class SkFILEStream
      5 
      6 A stream that wraps a C FILE* file stream. */
      7 
      8 #Code
      9 #Populate
     10 ##
     11 
     12 # ------------------------------------------------------------------------------
     13 
     14 #Method explicit SkFILEStream(const char path[] = nullptr)
     15 #In Constructors
     16 #Line # incomplete ##
     17 
     18 Initializes Stream by reading data contained by path.
     19 File descriptor is opened here and is closed when SkFILEStream
     20 destructor is invoked.
     21 
     22 #Param path  incomplete ##
     23 
     24 #Return incomplete ##
     25 
     26 #Example
     27 // incomplete
     28 ##
     29 
     30 #SeeAlso incomplete
     31 
     32 #Method ##
     33 
     34 # ------------------------------------------------------------------------------
     35 
     36 #Method explicit SkFILEStream(FILE* file)
     37 #In Constructors
     38 #Line # incomplete ##
     39 
     40 Initialize the stream with an existing C_FILE stream.
     41 The current position of the C_FILE stream will be considered the
     42 beginning of the SkFILEStream.
     43 The C_FILE stream is closed when SkFILEStream destructor is invoked.
     44 
     45 #Param file  incomplete ##
     46 
     47 #Return incomplete ##
     48 
     49 #Example
     50 // incomplete
     51 ##
     52 
     53 #SeeAlso incomplete
     54 
     55 #Method ##
     56 
     57 # ------------------------------------------------------------------------------
     58 
     59 #Method ~SkFILEStream() override
     60 #In Constructors
     61 #Line # incomplete ##
     62 
     63 #Example
     64 // incomplete
     65 ##
     66 
     67 #SeeAlso incomplete
     68 
     69 #Method ##
     70 
     71 # ------------------------------------------------------------------------------
     72 
     73 #Method static std::unique_ptr<SkFILEStream> Make(const char path[])
     74 #In incomplete
     75 #Line # incomplete ##
     76 
     77 #Param path  incomplete ##
     78 
     79 #Return incomplete ##
     80 
     81 #Example
     82 // incomplete
     83 ##
     84 
     85 #SeeAlso incomplete
     86 
     87 #Method ##
     88 
     89 # ------------------------------------------------------------------------------
     90 
     91 #Method bool isValid() const
     92 #In incomplete
     93 #Line # incomplete ##
     94 
     95 Returns true if the current path could be opened.
     96 
     97 #Return incomplete ##
     98 
     99 #Example
    100 // incomplete
    101 ##
    102 
    103 #SeeAlso incomplete
    104 
    105 #Method ##
    106 
    107 # ------------------------------------------------------------------------------
    108 
    109 #Method void close()
    110 #In incomplete
    111 #Line # incomplete ##
    112 
    113 Close this SkFILEStream.
    114 
    115 #Example
    116 // incomplete
    117 ##
    118 
    119 #SeeAlso incomplete
    120 
    121 #Method ##
    122 
    123 # ------------------------------------------------------------------------------
    124 
    125 #Method size_t read(void* buffer, size_t size) override
    126 #In incomplete
    127 #Line # incomplete ##
    128 
    129 #Param buffer  incomplete ##
    130 #Param size  incomplete ##
    131 
    132 #Return incomplete ##
    133 
    134 #Example
    135 // incomplete
    136 ##
    137 
    138 #SeeAlso incomplete
    139 
    140 #Method ##
    141 
    142 # ------------------------------------------------------------------------------
    143 
    144 #Method bool isAtEnd() const override
    145 #In incomplete
    146 #Line # incomplete ##
    147 
    148 #Return incomplete ##
    149 
    150 #Example
    151 // incomplete
    152 ##
    153 
    154 #SeeAlso incomplete
    155 
    156 #Method ##
    157 
    158 # ------------------------------------------------------------------------------
    159 
    160 #Method bool rewind() override
    161 #In incomplete
    162 #Line # incomplete ##
    163 
    164 #Return incomplete ##
    165 
    166 #Example
    167 // incomplete
    168 ##
    169 
    170 #SeeAlso incomplete
    171 
    172 #Method ##
    173 
    174 # ------------------------------------------------------------------------------
    175 
    176 #Method std::unique_ptr<SkStreamAsset> duplicate() const
    177 #In incomplete
    178 #Line # incomplete ##
    179 
    180 #Return incomplete ##
    181 
    182 #Example
    183 // incomplete
    184 ##
    185 
    186 #SeeAlso incomplete
    187 
    188 #Method ##
    189 
    190 # ------------------------------------------------------------------------------
    191 
    192 #Method size_t getPosition() const override
    193 #In incomplete
    194 #Line # incomplete ##
    195 
    196 #Return incomplete ##
    197 
    198 #Example
    199 // incomplete
    200 ##
    201 
    202 #SeeAlso incomplete
    203 
    204 #Method ##
    205 
    206 # ------------------------------------------------------------------------------
    207 
    208 #Method bool seek(size_t position) override
    209 #In incomplete
    210 #Line # incomplete ##
    211 
    212 #Param position  incomplete ##
    213 
    214 #Return incomplete ##
    215 
    216 #Example
    217 // incomplete
    218 ##
    219 
    220 #SeeAlso incomplete
    221 
    222 #Method ##
    223 
    224 # ------------------------------------------------------------------------------
    225 
    226 #Method bool move(long offset) override
    227 #In incomplete
    228 #Line # incomplete ##
    229 
    230 #Param offset  incomplete ##
    231 
    232 #Return incomplete ##
    233 
    234 #Example
    235 // incomplete
    236 ##
    237 
    238 #SeeAlso incomplete
    239 
    240 #Method ##
    241 
    242 # ------------------------------------------------------------------------------
    243 
    244 #Method std::unique_ptr<SkStreamAsset> fork() const
    245 #In incomplete
    246 #Line # incomplete ##
    247 
    248 #Return incomplete ##
    249 
    250 #Example
    251 // incomplete
    252 ##
    253 
    254 #SeeAlso incomplete
    255 
    256 #Method ##
    257 
    258 # ------------------------------------------------------------------------------
    259 
    260 #Method size_t getLength() const override
    261 #In incomplete
    262 #Line # incomplete ##
    263 
    264 #Return incomplete ##
    265 
    266 #Example
    267 // incomplete
    268 ##
    269 
    270 #SeeAlso incomplete
    271 
    272 #Method ##
    273 
    274 #Class SkFILEStream ##
    275 
    276 #Topic FILEStream ##
    277