Struct Formatted

pub struct Formatted<T> { /* private fields */ }

A value together with its to_string representation, including surrounding it whitespaces and comments.

Implementations

impl<T> Formatted<T>

where T: ValueRepr,

pub fn new(value: T) -> Self

Default-formatted value

pub fn value(&self) -> &T

The wrapped value

pub fn into_value(self) -> T

The wrapped value

pub fn as_repr(&self) -> Option<&Repr>

Returns the raw representation, if available.

pub fn default_repr(&self) -> Repr

Returns the default raw representation.

pub fn display_repr(&self) -> Cow<'_, str>

Returns a raw representation.

pub fn span(&self) -> Option<Range<usize>>

The location within the original document

This generally requires an ImDocument.

pub fn decor_mut(&mut self) -> &mut Decor

Returns the surrounding whitespace

pub fn decor(&self) -> &Decor

Returns the surrounding whitespace

pub fn fmt(&mut self)

Auto formats the value.

Trait Implementations

impl<T: Clone> Clone for Formatted<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Formatted<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Display for Formatted<T>

where T: ValueRepr,

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Formatted<T>

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

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<T: PartialEq> PartialEq for Formatted<T>

fn eq(&self, other: &Formatted<T>) -> 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<T: Eq> Eq for Formatted<T>

impl<T> StructuralPartialEq for Formatted<T>