🥮 mooncakes.io

    #Ion value model

    IonValue is deliberately structural. Struct fields are an ordered array of pairs, annotations are an ordered array, and IonSymbol can retain an unknown SID. This prevents a future symbol-table or Ion extension from being erased by a convenient map-based representation.

    Limits, IonError, IonDecimal, and IonTimestamp are shared by the decoder and encoder packages.

    IonError

    source
    pub(all) suberror IonError {
      Parse(kind~ : ErrorKind, offset~ : Int, line~ : Int, column~ : Int, message~ : String)
      Limit(kind~ : LimitKind, offset~ : Int, line~ : Int, column~ : Int, message~ : String)
      UnsupportedVersion(major~ : Int, minor~ : Int, offset~ : Int)
    } derive(
    Debug    )

    IonError::column

    source
    fn IonError::column(self : IonError) -> Int

    IonError::is_limit

    source
    fn IonError::is_limit(self : IonError) -> Bool

    Report whether this error was raised by a configured resource limit.

    IonError::kind

    source
    fn IonError::kind(self : IonError) -> ErrorKind

    IonError::limit_kind

    source
    fn IonError::limit_kind(self : IonError) -> LimitKind?

    Return the precise resource budget for a limit error without parsing text.

    IonError::line

    source
    fn IonError::line(self : IonError) -> Int

    IonError::location

    source
    fn IonError::location(self : IonError) -> IonLocation

    Return the zero-based offset and one-based line and column of this error.

    IonError::message

    source
    fn IonError::message(self : IonError) -> String

    IonError::offset

    source
    fn IonError::offset(self : IonError) -> Int

    IonError::summary

    source
    fn IonError::summary(self : IonError) -> String

    Return a compact, stable description suitable for logs and diagnostics.

    EncodeOptions

    source
    pub(all) struct EncodeOptions {
      pretty : Bool
      indent : Int
      emit_bvm : Bool
      limits : Limits
    } derive(
    Debug    )

    EncodeOptions::compact

    source
    fn EncodeOptions::compact(emit_bvm? : Bool, limits? : Limits) -> EncodeOptions

    Construct compact text output options with a configurable binary version marker.

    EncodeOptions::default

    source
    fn EncodeOptions::default() -> EncodeOptions

    EncodeOptions::emit_bvm

    source
    fn EncodeOptions::emit_bvm(self : EncodeOptions) -> Bool

    EncodeOptions::indent

    source
    fn EncodeOptions::indent(self : EncodeOptions) -> Int

    EncodeOptions::limits

    source
    fn EncodeOptions::limits(self : EncodeOptions) -> Limits

    EncodeOptions::new

    source
    fn EncodeOptions::new(pretty? : Bool, indent? : Int, emit_bvm? : Bool, limits? : Limits) -> EncodeOptions

    EncodeOptions::preflight_output_size

    source
    fn EncodeOptions::preflight_output_size(self : EncodeOptions, estimated_bytes : Int) -> Unit raise IonError

    Reject a predicted encoded size that exceeds the configured output limit.

    EncodeOptions::pretty

    source
    fn EncodeOptions::pretty(self : EncodeOptions) -> Bool

    EncodeOptions::readable

    source
    fn EncodeOptions::readable(indent? : Int, emit_bvm? : Bool, limits? : Limits) -> EncodeOptions raise IonError

    Construct readable text output options after validating the indentation width.

    EncodeOptions::validate

    source
    fn EncodeOptions::validate(self : EncodeOptions) -> Unit raise IonError

    Validate options that affect portable text output.

    Readable output accepts indentation widths from one through sixteen spaces.

    EncodeOptions::with_binary_version_marker

    source
    fn EncodeOptions::with_binary_version_marker(self : EncodeOptions, enabled~ : Bool) -> EncodeOptions

    Return these options with binary version-marker emission enabled or disabled.

    ErrorKind

    source
    pub(all) enum ErrorKind {
      UnexpectedEof
      InvalidSyntax
      InvalidBinary
      InvalidUtf8
      InvalidNumber
      InvalidTimestamp
      InvalidSymbol
      InvalidLength
      UnsupportedVersion
      LimitExceeded
    } derive(Eq, 
    Debug    )

    IonDecimal

    source
    pub(all) struct IonDecimal {
      coefficient : 
    BigInt
      exponent : Int
    } derive(Eq, 
    Debug    )

    IonDecimal::coefficient

    source

    IonDecimal::exponent

    source
    fn IonDecimal::exponent(self : IonDecimal) -> Int

    IonDecimal::new

    source
    fn IonDecimal::new(coefficient~ : 
    BigInt    , exponent~ : Int) -> IonDecimal

    IonDecimal::to_ion_text

    source
    fn IonDecimal::to_ion_text(self : IonDecimal) -> String

    Render a decimal as an Ion decimal literal while retaining its exact exponent.

    IonDecimal::to_text

    source
    fn IonDecimal::to_text(self : IonDecimal) -> String

    Render a decimal without losing its coefficient scale.

    IonLocation

    source
    pub(all) struct IonLocation {
      offset : Int
      line : Int
      column : Int
    } derive(Eq, 
    Debug    )

    A stable source position carried by an Ion diagnostic.

    IonLocation::format

    source
    fn IonLocation::format(self : IonLocation) -> String

    Render this location in the stable line:column (offset N) form.

    IonNull

    source
    pub(all) enum IonNull {
      Null
      Bool
      Int
      Float
      Decimal
      Timestamp
      Symbol
      String
      Blob
      Clob
      List
      Sexp
      Struct
    } derive(Eq, 
    Debug    )

    IonSymbol

    source
    pub(all) struct IonSymbol {
      text : String?
      sid : Int?
    } derive(Eq, 
    Debug    )

    IonSymbol::display

    source
    fn IonSymbol::display(self : IonSymbol) -> String

    Return readable symbol text, or a $sid form for an unresolved symbol.

    IonSymbol::from_sid

    source
    fn IonSymbol::from_sid(sid : Int) -> IonSymbol

    IonSymbol::from_text

    source
    fn IonSymbol::from_text(text : String) -> IonSymbol

    IonSymbol::is_resolved

    source
    fn IonSymbol::is_resolved(self : IonSymbol) -> Bool

    Report whether this symbol has text resolved from its symbol table.

    IonSymbol::sid_value

    source
    fn IonSymbol::sid_value(self : IonSymbol) -> Int?

    IonSymbol::text_value

    source
    fn IonSymbol::text_value(self : IonSymbol) -> String?

    IonSymbol::unknown

    source
    fn IonSymbol::unknown() -> IonSymbol

    IonTimestamp

    source
    pub(all) struct IonTimestamp {
      offset_minutes : Int?
      year : Int
      month : Int?
      day : Int?
      hour : Int?
      minute : Int?
      second : Int?
      fraction_exponent : Int?
      fraction_coefficient : 
    BigInt    ?
    } derive(Eq, 
    Debug    )

    IonTimestamp::day

    source
    fn IonTimestamp::day(self : IonTimestamp) -> Int?

    IonTimestamp::fraction_coefficient

    source

    IonTimestamp::fraction_exponent

    source
    fn IonTimestamp::fraction_exponent(self : IonTimestamp) -> Int?

    IonTimestamp::has_offset

    source
    fn IonTimestamp::has_offset(self : IonTimestamp) -> Bool

    Report whether the timestamp carries a known or unknown local offset.

    IonTimestamp::has_time

    source
    fn IonTimestamp::has_time(self : IonTimestamp) -> Bool

    Report whether the timestamp includes an hour and minute time component.

    IonTimestamp::hour

    source
    fn IonTimestamp::hour(self : IonTimestamp) -> Int?

    IonTimestamp::minute

    source
    fn IonTimestamp::minute(self : IonTimestamp) -> Int?

    IonTimestamp::month

    source
    fn IonTimestamp::month(self : IonTimestamp) -> Int?

    IonTimestamp::new

    source
    fn IonTimestamp::new(year~ : Int, month~ : Int?, day~ : Int?, hour~ : Int?, minute~ : Int?, second~ : Int?, offset_minutes~ : Int?, fraction_exponent~ : Int?, fraction_coefficient~ : 
    BigInt    ?) -> IonTimestamp

    IonTimestamp::offset_minutes

    source
    fn IonTimestamp::offset_minutes(self : IonTimestamp) -> Int?

    IonTimestamp::offset_text

    source
    fn IonTimestamp::offset_text(self : IonTimestamp) -> String

    Render the timestamp offset as Z, a signed offset, or -00:00 when unknown.

    IonTimestamp::precision

    source
    fn IonTimestamp::precision(self : IonTimestamp) -> Int

    Return the timestamp precision from year-only through fractional seconds.

    IonTimestamp::second

    source
    fn IonTimestamp::second(self : IonTimestamp) -> Int?

    IonTimestamp::year

    source
    fn IonTimestamp::year(self : IonTimestamp) -> Int

    IonValue

    source
    pub(all) enum IonValue {
      Null(IonNull)
      Bool(Bool)
      Int(
    BigInt    )
      Float(Float)
      Decimal(IonDecimal)
      Timestamp(IonTimestamp)
      Symbol(IonSymbol)
      String(String)
      Blob(Bytes)
      Clob(Bytes)
      List(Array[IonValue])
      Sexp(Array[IonValue])
      Struct(Array[(IonSymbol, IonValue)])
      Annotated(Array[IonSymbol], IonValue)
    } derive(Eq, 
    Debug    )

    IonValue::annotations

    source
    fn IonValue::annotations(self : IonValue) -> Array[IonSymbol]

    Return a copy of the annotations attached to a value.

    IonValue::as_bool

    source
    fn IonValue::as_bool(self : IonValue) -> Bool?

    Return the underlying boolean when the value is a boolean.

    IonValue::as_decimal

    source
    fn IonValue::as_decimal(self : IonValue) -> IonDecimal?

    Return the decimal payload when the value is a decimal.

    IonValue::as_int

    source

    Return the arbitrary-precision integer when the value is an integer.

    IonValue::as_string

    source
    fn IonValue::as_string(self : IonValue) -> String?

    Return the underlying string when the value is a string.

    IonValue::as_timestamp

    source
    fn IonValue::as_timestamp(self : IonValue) -> IonTimestamp?

    Return the timestamp payload when the value is a timestamp.

    IonValue::bool

    source
    fn IonValue::bool(value : Bool) -> IonValue

    Construct an Ion boolean value.

    IonValue::decimal

    source
    fn IonValue::decimal(value : IonDecimal) -> IonValue

    Construct an Ion decimal while preserving its coefficient and exponent.

    IonValue::elements

    source
    fn IonValue::elements(self : IonValue) -> Array[IonValue]

    Return a copy of the elements in a list or s-expression.

    IonValue::empty_list

    source
    fn IonValue::empty_list() -> IonValue

    IonValue::empty_struct

    source
    fn IonValue::empty_struct() -> IonValue

    IonValue::fields

    source
    fn IonValue::fields(self : IonValue) -> Array[(IonSymbol, IonValue)]

    Return a copy of the ordered fields in a struct.

    IonValue::get_field

    source
    fn IonValue::get_field(self : IonValue, name : String) -> IonValue?

    Return the first struct field whose symbol has the requested text.

    IonValue::get_fields

    source
    fn IonValue::get_fields(self : IonValue, name : String) -> Array[IonValue]

    Return all struct fields whose symbols have the requested text.

    IonValue::int

    source

    Construct an Ion integer without narrowing its arbitrary-precision payload.

    IonValue::is_null

    source
    fn IonValue::is_null(self : IonValue) -> Bool

    Report whether a value is either a plain or typed Ion null.

    IonValue::kind

    source
    fn IonValue::kind(self : IonValue) -> IonNull

    Return the Ion type of a value, ignoring any annotations around it.

    IonValue::null

    source
    fn IonValue::null(kind~ : IonNull) -> IonValue

    IonValue::string

    source
    fn IonValue::string(value : String) -> IonValue

    Construct an Ion string value.

    IonValue::symbol

    source
    fn IonValue::symbol(text~ : String) -> IonValue

    IonValue::timestamp

    source
    fn IonValue::timestamp(value : IonTimestamp) -> IonValue

    Construct an Ion timestamp while preserving its declared precision and offset.

    IonValue::with_annotations

    source
    fn IonValue::with_annotations(self : IonValue, annotations : ArrayView[IonSymbol]) -> IonValue

    Attach annotations while keeping existing annotations in their original order.

    IonValue::without_annotations

    source
    fn IonValue::without_annotations(self : IonValue) -> IonValue

    Remove all annotations and return the underlying value.

    LimitKind

    source
    pub(all) enum LimitKind {
      TotalBytes
      Depth
      Values
      ContainerItems
      TextBytes
      BlobBytes
      SymbolCount
    } derive(Eq, 
    Debug    )

    Limits

    source
    pub(all) struct Limits {
      max_depth : Int
      max_values : Int
      max_container_items : Int
      max_text_bytes : Int
      max_blob_bytes : Int
      max_total_bytes : Int
      max_symbols : Int
    } derive(Eq, 
    Debug    )

    Limits::default

    source
    fn Limits::default() -> Limits

    Limits::max_blob_bytes

    source
    fn Limits::max_blob_bytes(self : Limits) -> Int

    Limits::max_container_items

    source
    fn Limits::max_container_items(self : Limits) -> Int

    Limits::max_depth

    source
    fn Limits::max_depth(self : Limits) -> Int

    Limits::max_symbols

    source
    fn Limits::max_symbols(self : Limits) -> Int

    Limits::max_text_bytes

    source
    fn Limits::max_text_bytes(self : Limits) -> Int

    Limits::max_total_bytes

    source
    fn Limits::max_total_bytes(self : Limits) -> Int

    Limits::max_values

    source
    fn Limits::max_values(self : Limits) -> Int

    Limits::new

    source
    fn Limits::new(max_depth? : Int, max_values? : Int, max_container_items? : Int, max_text_bytes? : Int, max_blob_bytes? : Int, max_total_bytes? : Int, max_symbols? : Int) -> Limits

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io