Struct biblatex::Spanned

pub struct Spanned<T> {
    pub v: T,
    pub span: Range<usize>,
}

A value with the span it corresponds to in the source code.

Spans can be detached, this means that they deliberately do not point into the source code. Such spans are created when manually setting fields with an empty bibliography or after parsing a file. Detached spans do not indicate valid index ranges in the source files and must not be used as such. A spanned item can be checked for detachment by calling Self::is_detached.

Fields

v: T

The spanned value.

span: Range<usize>

The location in source code of the value.

Implementations

impl<T> Spanned<T>

pub fn new(v: T, span: Range<usize>) -> Self

Create a new instance from a value and its span.

pub fn zero(v: T) -> Self

Create a new instance with a value and a zero-length span.

pub fn detached(v: T) -> Self

Create a new instance with a detached span.

pub fn is_detached(&self) -> bool

Whether the span is detached.

pub fn as_ref(&self) -> Spanned<&T>

Convert from &Spanned<T> to Spanned<&T>

pub fn map<F, U>(self, f: F) -> Spanned<U>where F: FnOnce(T) -> U,

Map the value using a function keeping the span.

Trait Implementations

impl<T: Clone> Clone for Spanned<T>

fn clone(&self) -> Spanned<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Spanned<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Spanned<T>

fn eq(&self, other: &Spanned<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Eq> Eq for Spanned<T>

impl<T> StructuralEq for Spanned<T>

impl<T> StructuralPartialEq for Spanned<T>