Skip to main content

Source

Struct Source 

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

Original YAML input plus line-start metadata.

Implementations§

Source§

impl Source

Source

pub fn new(text: String) -> Result<Source, YamlError>

Builds a source buffer, validates YAML 1.2.2 printable characters, and records all line starts.

§Errors

Returns an error when text contains characters that are not valid in a YAML 1.2.2 stream.

Source

pub fn as_str(&self) -> &str

Returns the original input text.

Source

pub fn len(&self) -> usize

Returns the source length in bytes.

Source

pub fn is_empty(&self) -> bool

Returns true when the source is empty.

Source

pub fn line_starts(&self) -> &[u32]

Returns the recorded line-start byte offsets.

Source

pub fn slice(&self, span: Span) -> &str

Returns the source slice for span.

§Panics

Panics if span is outside the source or does not fall on UTF-8 boundaries. Use Source::try_slice when handling user-provided spans.

Source

pub fn try_slice(&self, span: Span) -> Result<&str, YamlError>

Returns the source slice for span, or a span-rich error when invalid.

§Errors

Returns an error when span is outside the source text or does not fall on UTF-8 boundaries.

Source

pub fn line_col(&self, offset: usize) -> LineCol

Converts a byte offset into a one-based line/column pair.

Source

pub fn diagnostic_position(&self, diagnostic: &Diagnostic) -> LineCol

Returns the line/column pair for a diagnostic’s primary span.

Trait Implementations§

Source§

impl Clone for Source

Source§

fn clone(&self) -> Source

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 Source

Source§

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

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

impl Eq for Source

Source§

impl PartialEq for Source

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Source

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.