Struct Sequence 

pub struct Sequence(/* private fields */);

A YAML sequence (list)

Note: This type uses interior mutability through the rowan library. Mutation methods work even when called through &self. See the crate-level documentation for details on the mutability model.

Implementations

impl Sequence

pub fn values(&self) -> impl Iterator<Item = YamlNode>

Iterate over items in this sequence as YamlNodes.

Items that cannot be wrapped as a YamlNode are silently skipped.

pub fn len(&self) -> usize

Returns the number of items in this sequence.

pub fn is_empty(&self) -> bool

Returns true if this sequence contains no items.

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

Get the item at index as a YamlNode.

Returns None if index is out of bounds.

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

Get the first item in this sequence, or None if empty.

pub fn last(&self) -> Option<YamlNode>

Get the last item in this sequence, or None if empty.

impl Sequence

pub fn push(&self, value: impl AsYaml)

Add an item to the end of the sequence.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn insert(&self, index: usize, value: impl AsYaml)

Insert an item at a specific position.

If index is out of bounds, the item is appended at the end. This method always succeeds; it never returns an error.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn set(&self, index: usize, value: impl AsYaml) -> bool

Replace the item at index with a new value.

Returns true if the index was in bounds and the item was replaced, false if index >= len().

Mutates in place despite &self (see crate docs on interior mutability).

pub fn remove(&self, index: usize) -> Option<YamlNode>

Remove the item at index, returning its value.

Returns Some(value) if the index was in bounds, None otherwise.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn is_flow_style(&self) -> bool

Check if this sequence is in flow style [item1, item2]

pub fn pop(&self) -> Option<YamlNode>

Remove and return the last item in this sequence.

Returns None if the sequence is empty.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn clear(&self)

Remove all items from this sequence.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn byte_range(&self) -> TextPosition

Get the byte offset range of this sequence in the source text.

Returns the start and end byte offsets as a TextPosition.

pub fn start_position(&self, source_text: &str) -> LineColumn

Get the line and column where this sequence starts.

Requires the original source text to calculate line/column from byte offsets. Line and column numbers are 1-indexed.

Arguments

• source_text - The original YAML source text

pub fn end_position(&self, source_text: &str) -> LineColumn

Get the line and column where this sequence ends.

Requires the original source text to calculate line/column from byte offsets. Line and column numbers are 1-indexed.

Arguments

• source_text - The original YAML source text

Trait Implementations

impl AsYaml for Sequence

fn as_node(&self) -> Option<&SyntaxNode<Lang>>

Returns a reference to the underlying SyntaxNode if one exists.

fn kind(&self) -> YamlKind

Returns the kind of YAML value this represents.

fn build_content( &self, builder: &mut GreenNodeBuilder<'_>, indent: usize, _flow_context: bool, ) -> bool

Serialize this value into a GreenNodeBuilder.

fn is_inline(&self) -> bool

Returns whether this value should be rendered on the same line as its key.

impl AstNode for Sequence

type Language = Lang

fn can_cast(kind: SyntaxKind) -> bool

fn cast(syntax: SyntaxNode<Lang>) -> Option<Sequence>

fn syntax(&self) -> &SyntaxNode<Lang>

fn clone_for_update(&self) -> Self

where Self: Sized,

fn clone_subtree(&self) -> Self

where Self: Sized,

impl Clone for Sequence

fn clone(&self) -> Sequence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sequence

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

Formats the value using the given formatter.

impl Display for Sequence

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

Formats the value using the given formatter.

impl Eq for Sequence

impl Hash for Sequence

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a Sequence

type Item = YamlNode

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = YamlNode> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Sequence as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for Sequence

fn eq(&self, other: &Sequence) -> 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 StructuralPartialEq for Sequence

impl YamlAccept for Sequence

fn accept<V>(&self, visitor: &mut V)

where V: YamlVisitor,

Accept a visitor for traversal