Skip to main content

Sequence

Struct Sequence 

Source
pub struct Sequence { /* private fields */ }
Expand description

An iterable, addressable series of Ion Elements.

A Sequence is not itself an Ion value type, but can represent a series of Ion values appearing in a List, a SExp, or at the top level.

Implementations§

Source§

impl Sequence

Source

pub fn new<E: Into<Element>, I: IntoIterator<Item = E>>(elements: I) -> Sequence

Source

pub fn builder() -> SequenceBuilder

Source

pub fn clone_builder(&self) -> SequenceBuilder

Source

pub fn elements(&self) -> SequenceIterator<'_>

Source

pub fn get(&self, index: usize) -> Option<&Element>

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

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

Source

pub fn encode_as<E: Encoding, C: Into<WriteConfig<E>>>( &self, config: C, ) -> IonResult<E::Output>

use ion_rs::{Element, Sequence};
use ion_rs::v1_0::Binary;

let ion_data = r#"1 2 3 foo bar baz"#;
let sequence_before: Sequence = Element::read_all(ion_data)?;

// Encode the elements in this sequence as a binary Ion stream.
let ion_bytes: Vec<u8> = sequence_before.encode_as(Binary)?;
// Read the sequence back from the binary stream
let sequence_after = Element::read_all(ion_bytes)?;

// Confirm that the value we read back is identical to the one we serialized
assert_eq!(sequence_before, sequence_after);
Source

pub fn encode_to<E: Encoding, C: Into<WriteConfig<E>>, W: Write>( &self, output: W, config: C, ) -> IonResult<W>

use ion_rs::{Element, Sequence};
use ion_rs::v1_0::Binary;

let ion_data = r#"1 2 3 foo bar baz"#;
let sequence_before: Sequence = Element::read_all(ion_data)?;

// Encode the elements in this sequence to our buffer as a binary Ion stream. The bytes will
// be written to the provided Vec<u8>, and the Vec<u8> will be returned when encoding is complete.
let ion_bytes: Vec<u8> = sequence_before.encode_to(Vec::new(), Binary)?;
// Read the sequence back from the binary stream
let sequence_after = Element::read_all(ion_bytes)?;

// Confirm that the value we read back is identical to the one we serialized
assert_eq!(sequence_before, sequence_after);

Trait Implementations§

Source§

impl AsRef<Sequence> for Sequence

Source§

fn as_ref(&self) -> &Sequence

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl AsRef<Sequence> for List

Source§

fn as_ref(&self) -> &Sequence

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl AsRef<Sequence> for SExp

Source§

fn as_ref(&self) -> &Sequence

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl AsRef<[Element]> for Sequence

Source§

fn as_ref(&self) -> &[Element]

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for Sequence

Source§

fn clone(&self) -> Sequence

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Sequence

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<List> for Sequence

Source§

fn from(value: List) -> Self

Converts to this type from the input type.
Source§

impl From<SExp> for Sequence

Source§

fn from(value: SExp) -> Self

Converts to this type from the input type.
Source§

impl From<Sequence> for Vec<Element>

Source§

fn from(value: Sequence) -> Self

Converts to this type from the input type.
Source§

impl From<Sequence> for List

Source§

fn from(sequence: Sequence) -> Self

Converts to this type from the input type.
Source§

impl From<Sequence> for SExp

Source§

fn from(sequence: Sequence) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<Element>> for Sequence

Source§

fn from(elements: Vec<Element>) -> Self

Converts to this type from the input type.
Source§

impl FromIterator<Element> for Sequence

Source§

fn from_iter<T: IntoIterator<Item = Element>>(iter: T) -> Self

Creates a value from an iterator. Read more
Source§

impl<'a> IntoIterator for &'a Sequence

Source§

type Item = &'a Element

The type of the elements being iterated over.
Source§

type IntoIter = SequenceIterator<'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoIterator for Sequence

Source§

type Item = Element

The type of the elements being iterated over.
Source§

type IntoIter = OwnedSequenceIterator

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for Sequence

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Sequence

Source§

impl TryFrom<Element> for Sequence

Source§

type Error = ConversionOperationError<Element, Sequence>

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.