Struct Struct 

pub struct Struct { /* private fields */ }

An in-memory representation of an Ion Struct

use ion_rs::{Element, ion_struct};
let struct_ = ion_struct! {
  "foo": 1,
  "bar": true,
  "baz": "hello"
};
assert_eq!(struct_.len(), 3);
assert_eq!(struct_.get("baz"), Some(&Element::string("hello")));

Implementations

impl Struct

pub fn builder() -> StructBuilder

pub fn clone_builder(&self) -> StructBuilder

pub fn fields(&self) -> impl Iterator<Item = (&Symbol, &Element)>

Returns an iterator over the field name/value pairs in this Struct.

pub fn len(&self) -> usize

Returns the number of fields in this Struct.

pub fn is_empty(&self) -> bool

Returns true if this struct has zero fields.

pub fn iter(&self) -> FieldIterator<'_>

pub fn get<A: AsSymbolRef>(&self, field_name: A) -> Option<&Element>

Returns the value associated with the specified field name.

If more than one field in this struct has that name, this method will return the value of the last field with that name. To access other fields with the same name, see get_all.

pub fn get_all<A: AsSymbolRef>( &self, field_name: A, ) -> impl Iterator<Item = &Element>

Returns an iterator over all of the values associated with the specified field name.

Trait Implementations

impl Clone for Struct

fn clone(&self) -> Struct

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Struct

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Struct

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Struct> for Value

fn from(struct_val: Struct) -> Self

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for Struct

where K: Into<Symbol>, V: Into<Element>,

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Returns an owned struct from the given iterator of field names/values.

impl<'a> IntoIterator for &'a Struct

type Item = (&'a Symbol, &'a Element)

The type of the elements being iterated over.

type IntoIter = FieldIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Struct

type Item = (Symbol, Element)

The type of the elements being iterated over.

type IntoIter = OwnedFieldIterator

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Struct

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Element> for Struct

type Error = ConversionOperationError<Element, Struct>

The type returned in the event of a conversion error.

fn try_from(element: Element) -> ConversionOperationResult<Element, Struct>

Performs the conversion.