Flyology_CBOR.Allocating_Writing

Description

Writer is single-owner and not task-safe. It owns explicitly allocating unpublished staging. Mutation-time Storage_Error enters Failed, makes partial staging ineligible, then re-raises. Scope exit discards unpublished staging and cannot publish it. No retained self-reference or controlled finalizer is required.

Abort_Document

procedure Abort_Document
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Applied_Profile

function Applied_Profile (Self : Writer) return Profiles.Writer_Profile

Parameters

Self

Return value

Begin_Array

procedure Begin_Array
  (Self       : in out Writer;
   Length     : Interfaces.Unsigned_64;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Length

Diagnostic

Begin_Byte_String

procedure Begin_Byte_String
  (Self       : in out Writer;
   Length     : Interfaces.Unsigned_64;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Length

Diagnostic

Begin_Byte_String_Chunk

procedure Begin_Byte_String_Chunk
  (Self       : in out Writer;
   Length     : Interfaces.Unsigned_64;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Length

Diagnostic

Begin_Document

procedure Begin_Document
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Begin_Indefinite_Array

procedure Begin_Indefinite_Array
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Begin_Indefinite_Byte_String

procedure Begin_Indefinite_Byte_String
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Begin_Indefinite_Map

procedure Begin_Indefinite_Map
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Begin_Indefinite_Text_String

procedure Begin_Indefinite_Text_String
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Begin_Map

procedure Begin_Map
  (Self       : in out Writer;
   Pair_Count : Interfaces.Unsigned_64;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Pair_Count

Diagnostic

Begin_Tag

procedure Begin_Tag
  (Self       : in out Writer;
   Number     : Values.Tag_Number;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Number

Diagnostic

Begin_Text_String

procedure Begin_Text_String
  (Self         : in out Writer;
   Octet_Length : Interfaces.Unsigned_64;
   Diagnostic   : out Errors.Diagnostic)

Parameters

Self

Octet_Length

Diagnostic

Begin_Text_String_Chunk

procedure Begin_Text_String_Chunk
  (Self         : in out Writer;
   Octet_Length : Interfaces.Unsigned_64;
   Diagnostic   : out Errors.Diagnostic)

Parameters

Self

Octet_Length

Diagnostic

Committed_Length

function Committed_Length
  (Self : Writer) return Ada.Streams.Stream_Element_Count

Parameters

Self

Return value

End_Array

procedure End_Array
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

End_Byte_String

procedure End_Byte_String
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

End_Byte_String_Chunk

procedure End_Byte_String_Chunk
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

End_Map

procedure End_Map
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

End_Tag

procedure End_Tag
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

End_Text_String

procedure End_Text_String
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

End_Text_String_Chunk

procedure End_Text_String_Chunk
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Finish_Document

procedure Finish_Document
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Has_Applied_Profile

function Has_Applied_Profile (Self : Writer) return Boolean

Parameters

Self

Return value

Initialize

procedure Initialize
  (Self       : in out Writer;
   Profile    : Profiles.Writer_Profile;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Profile

Diagnostic

Output

function Output
  (Self : Writer) return Ada.Streams.Stream_Element_Array

Parameters

Self

Return value

Put_Byte_String_Fragment

procedure Put_Byte_String_Fragment
  (Self       : in out Writer;
   Value      : Ada.Streams.Stream_Element_Array;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Value

Diagnostic

Put_False

procedure Put_False
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Put_Float

procedure Put_Float
  (Self       : in out Writer;
   Value      : Values.Float_Value;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Value

Diagnostic

Put_Negative_Argument

procedure Put_Negative_Argument
  (Self       : in out Writer;
   Argument   : Interfaces.Unsigned_64;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Argument

Diagnostic

Put_Null

procedure Put_Null
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Put_Signed

procedure Put_Signed
  (Self       : in out Writer;
   Value      : Interfaces.Integer_64;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Value

Diagnostic

Put_Simple

procedure Put_Simple
  (Self       : in out Writer;
   Value      : Values.Simple_Code;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Value

Diagnostic

Put_Text_String_Fragment

procedure Put_Text_String_Fragment
  (Self       : in out Writer;
   Value      : Ada.Streams.Stream_Element_Array;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Value

Diagnostic

Put_True

procedure Put_True
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Put_Undefined

procedure Put_Undefined
  (Self       : in out Writer;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Diagnostic

Put_Unsigned

procedure Put_Unsigned
  (Self       : in out Writer;
   Value      : Interfaces.Unsigned_64;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Value

Diagnostic

Reset

procedure Reset
  (Self       : in out Writer;
   Profile    : Profiles.Writer_Profile;
   Diagnostic : out Errors.Diagnostic)

Parameters

Self

Profile

Diagnostic

State

function State (Self : Writer) return Writer_State

Parameters

Self

Return value

Terminal_Diagnostic

function Terminal_Diagnostic (Self : Writer) return Errors.Diagnostic

Parameters

Self

Return value

Writer

type Writer (Maximum_Syntax_Depth : Natural) is limited private;

Record fields

Maximum_Syntax_Depth

Writer_State

type Writer_State is
  (Uninitialized,
   Ready,
   Active,
   Completed,
   Failed,
   Aborted);

Writer is single-owner and not task-safe. It owns explicitly allocating unpublished staging. Mutation-time Storage_Error enters Failed, makes partial staging ineligible, then re-raises. Scope exit discards unpublished staging and cannot publish it. No retained self-reference or controlled finalizer is required.

Enumeration literals

Uninitialized

Ready

Active

Completed

Failed

Aborted