Enum StyledString

pub enum StyledString {
    Line(Vec<StyledString>),
    Stack(Vec<StyledString>),
    Text(RcStr),
    Code(RcStr),
    Strong(RcStr),
}

Represents a section of structured styled text. This can be interpreted and rendered by various UIs as appropriate, e.g. HTML for display on the web, ANSI sequences in TTYs.

Variants

Line(Vec<StyledString>)

Multiple StyledStrings concatenated into a single line. Each item is considered as inline element. Items might contain line breaks, which would be considered as soft line breaks.

Stack(Vec<StyledString>)

Multiple StyledStrings stacked vertically. They are considered as block elements, just like the top level StyledString.

Text(RcStr)

Some prose text.

Code(RcStr)

Code snippet.

Strong(RcStr)

Some important text.

Implementations

impl StyledString

pub fn cell(self) -> Vc<Self>

Places a value in a cell of the current task.

Cell is selected based on the value type and call order of cell.

pub fn resolved_cell(self) -> ResolvedVc<Self>

Places a value in a cell of the current task. Returns a ResolvedVc.

Cell is selected based on the value type and call order of cell.

Trait Implementations

impl Clone for StyledString

fn clone(&self) -> StyledString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StyledString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StyledString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DeterministicHash for StyledString

fn deterministic_hash<H: DeterministicHasher>(&self, __state__: &mut H)

Adds self’s bytes to the DeterministicHasher’s state, in a way that is replicatable on any platform or process run.

impl From<StyledString> for Vc<StyledString>

fn from(value: StyledString) -> Self

Converts to this type from the input type.

impl Ord for StyledString

fn cmp(&self, other: &StyledString) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StyledString

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

fn partial_cmp(&self, other: &StyledString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for StyledString

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ShrinkToFit for StyledString

fn shrink_to_fit(&mut self)

impl TraceRawVcs for StyledString

fn trace_raw_vcs(&self, __context__: &mut TraceRawVcsContext)

fn get_raw_vcs(&self) -> Vec<RawVc>

impl ValueDebug for StyledString

fn dbg(self: Vc<Self>) -> Vc<ValueDebugString>

fn dbg_depth(self: Vc<Self>, depth: usize) -> Vc<ValueDebugString>

Like dbg, but with a depth limit.

impl ValueDebugFormat for StyledString

fn value_debug_format<'a>(&'a self, depth: usize) -> ValueDebugFormatString<'a>

impl VcValueType for StyledString

type Read = VcDefaultRead<StyledString>

How to read the value.

type CellMode = VcCellSharedMode<StyledString>

How to update cells of this value type.

fn get_value_type_id() -> ValueTypeId

Returns the type id of the value type.

impl Eq for StyledString

impl NonLocalValue for StyledString

impl StructuralPartialEq for StyledString

impl Upcast<Box<dyn ValueDebug>> for StyledString