FloeFileBatches implements OffsetSkippingFileBatches
Read onlyYes
FinalYes
Interfaces
Methods
- __construct() : mixed
- batches() : Generator<mixed, void>
- Skips the whole file when the window's offset covers it; otherwise reads from the offset. A split owns the sections whose midpoint its byte window holds, and a window without a length owns every section.
- close() : void
- describe() : null|Description
- fromDescription() : static
Methods
__construct()
public
__construct(Codec $codec, int $chunkSize, null|DerivedSchema $derived) : mixed
Parameters
- $codec : Codec
- $chunkSize : int
- $derived : null|DerivedSchema
-
the schema every file must match; null under unionByName
batches()
Skips the whole file when the window's offset covers it; otherwise reads from the offset. A split owns the sections whose midpoint its byte window holds, and a window without a length owns every section.
public
batches(FileRead $read, Criteria $criteria, SourceFile $source, Schema $body, Backend $backend, ReadWindow $window) : Generator<mixed, void>
Parameters
- $read : FileRead
- $criteria : Criteria
- $source : SourceFile
- $body : Schema
- $backend : Backend
- $window : ReadWindow
Tags
Return values
Generator<mixed, void>close()
public
close() : void
describe()
public
describe() : null|Description
Return values
null|Description —null when this instance cannot cross a process boundary (a live client, a custom collaborator)
fromDescription()
public
static fromDescription(array<string|int, mixed> $data, Rebuild $rebuild) : static
Parameters
- $data : array<string|int, mixed>
- $rebuild : Rebuild