Gemstone Common Library
ISupport
Span-optimized binary image production/consumption with buffered I/O helpers.
Optional companion to ISupportBinaryImage; most callers only need to
implement the two span methods. Everything else has sensible defaults.
Definition
Namespace: Gemstone.IO.Parsing
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.141 -- Release Build+8fc1477299d57116e2a4f3cb8dfe059f814b239b
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.141 -- Release Build+8fc1477299d57116e2a4f3cb8dfe059f814b239b
C#
public interface ISupportBinaryImageSpan : ISupportBinaryImageVB
Public Interface ISupportBinaryImageSpan
Inherits ISupportBinaryImageC++
public interface class ISupportBinaryImageSpan : ISupportBinaryImageJavaScript
Gemstone.IO.Parsing.ISupportBinaryImageSpan = function();
Gemstone.IO.Parsing.ISupportBinaryImageSpan.createInterface('Gemstone.IO.Parsing.ISupportBinaryImageSpan');- Implements
- ISupportBinaryImage
Properties
| BinaryLength |
Gets the length of the binary image.
(Inherited from ISupportBinaryImage) |
Methods
| GenerateBinaryImage(SpanByte) | Writes this object's binary image to destination. |
| GenerateBinaryImage(Byte, Int32) |
Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.
(Inherited from ISupportBinaryImage) |
| GetRequiredLength | Determines how many bytes are required to parse this instance from the given sequence. Default assumes fixed-size and returns BinaryLength. Override for variable-length formats (peek a header, etc.). |
| ParseBinaryImage(ReadOnlySpanByte) | Parses this object's state from source. |
| ParseBinaryImage(ReadOnlySequenceByte, Boolean) | Parses from a ReadOnlySequenceT and returns bytes consumed. |
| ParseBinaryImage(Byte, Int32, Int32) |
Initializes object by parsing the specified buffer containing a binary image.
(Inherited from ISupportBinaryImage) |
| TryGenerateBinaryImage | Attempts to write this object's binary image to the specified destination span. |
| TryParse | Parses from a streaming reader; advances by bytes consumed. Implemented in terms of ParseBinaryImage(ReadOnlySequenceByte, Boolean). |
| TryParseBinaryImage | Attempts to parse this object's state from the specified source span. |
| WriteBinaryImage | Writes this object's binary image to the specified writer. |
Extension Methods
| BinaryImage |
Returns a binary image of an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions) |
| BinaryImageAsync |
Asynchronously returns a binary image of an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions) |
| CopyBinaryImageToStream |
Copies the binary image of the specified ISupportBinaryImage to the provided Stream.
(Defined by ISupportBinaryImageExtensions) |
| CopyBinaryImageToStreamAsync |
Asynchronously copies the binary image of an object that implements ISupportBinaryImage to the specified Stream.
(Defined by ISupportBinaryImageExtensions) |
| ParseBinaryImageFromStream |
Parses a binary image from the specified Stream into an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions) |
| ParseBinaryImageFromStreamAsync |
Asynchronously parses a binary image from the specified Stream into an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions) |