Struct Annotations

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

An ordered sequence of symbols that convey additional, application-specific information about their associated Ion value.

The IntoAnnotations trait is a convenient way to convert collections of symbol convertible things (including &str and String) into this sequence.

use ion_rs::element::{Annotations, IntoAnnotations};
let annotations: Annotations = ["foo", "bar", "baz"].into_annotations();
for annotation in &annotations {
    assert_eq!(annotation.text().map(|s| s.len()), Some(3));
}

Implementations§

Source§

impl Annotations

Source

pub fn empty() -> Self

Constructs an Annotations object representing an empty symbol sequence

Source

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

Returns an Iterator that yields each of the Symbols in this annotations sequence in order.

Source

pub fn len(&self) -> usize

Returns the number of annotations in this sequence.

use ion_rs::element::{Annotations, IntoAnnotations};
let annotations: Annotations = ["foo", "bar", "baz"].into_annotations();
assert_eq!(annotations.len(), 3);
Source

pub fn is_empty(&self) -> bool

Returns true if this sequence contains zero annotations. Otherwise, returns false.

use ion_rs::element::{Annotations, IntoAnnotations};
let annotations: Annotations = ["foo", "bar", "baz"].into_annotations();
assert!(!annotations.is_empty());
Source

pub fn contains<S: AsRef<str>>(&self, query: S) -> bool

Returns true if any symbol in this annotations sequence is equal to the provided text. Otherwise, returns false.

use ion_rs::element::{Annotations, IntoAnnotations};
let annotations: Annotations = ["foo", "bar", "baz"].into_annotations();
assert!(annotations.contains("foo"));
assert!(annotations.contains("bar"));
assert!(annotations.contains("baz"));

assert!(!annotations.contains("quux"));
assert!(!annotations.contains("quuz"));
Source

pub fn first(&self) -> Option<&str>

Returns the text of the first annotation in this sequence.

If the sequence is empty, returns None. If the first annotation in the sequence is $0 (symbol ID 0), returns None. Otherwise, returns a Some(&str) containing the text.

To view the first annotation as a Symbol rather than a &str, use annotations.iter().next().

use ion_rs::element::{Annotations, IntoAnnotations};
use ion_rs::Symbol;
let annotations: Annotations = ["foo", "bar", "baz"].into_annotations();
assert_eq!(annotations.first(), Some("foo"));

let empty_sequence: Vec<&str> = vec![];
let annotations: Annotations = empty_sequence.into_annotations();
assert_eq!(annotations.first(), None);

let annotations: Annotations = [Symbol::unknown_text()].into_annotations();
assert_eq!(annotations.first(), None)

Trait Implementations§

Source§

impl Clone for Annotations

Source§

fn clone(&self) -> Annotations

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Annotations

Source§

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

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

impl From<Vec<Symbol>> for Annotations

Source§

fn from(value: Vec<Symbol>) -> Self

Converts to this type from the input type.
Source§

impl<S: Into<Symbol>> FromIterator<S> for Annotations

Source§

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

Creates a value from an iterator. Read more
Source§

impl<'a> IntoIterator for &'a Annotations

Source§

type Item = &'a Symbol

The type of the elements being iterated over.
Source§

type IntoIter = SymbolsIterator<'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 Annotations

Source§

type Item = Symbol

The type of the elements being iterated over.
Source§

type IntoIter = AnnotationsIntoIter

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 Annotations

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const 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 Eq for Annotations

Source§

impl StructuralPartialEq for Annotations

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<S, I> IntoAnnotations for I
where S: Into<Symbol>, I: IntoIterator<Item = S>,

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.