Struct TextPropertyEntry 

pub struct TextPropertyEntry {
    pub text: String,
    pub properties: HashMap<String, Value>,
    pub style: Option<OverlayOptions>,
    pub inline_overlays: Vec<InlineOverlay>,
    pub segments: Vec<StyledSegment>,
    pub pad_to_chars: Option<u32>,
    pub truncate_to_chars: Option<u32>,
}

An entry with text and its properties

Fields

text: String

The text content. When segments is non-empty text is rebuilt from concatenating segment text during normalize_widths and any value supplied here is replaced.

properties: HashMap<String, Value>

Properties for this text

style: Option<OverlayOptions>

Optional whole-entry styling

inline_overlays: Vec<InlineOverlay>

Optional sub-range styling within this entry

segments: Vec<StyledSegment>

Optional segment list. When non-empty the host concatenates segment text into text and pushes one InlineOverlay (in Char units) per styled segment plus the segment’s nested overlays shifted by its position. Resolved before truncate/pad/char-byte conversion in normalize_widths.

pad_to_chars: Option<u32>

Pad text with spaces to this many display columns (Unicode codepoints). No-op when text already has at least this many codepoints. Applied before overlays are resolved.

truncate_to_chars: Option<u32>

Truncate text to at most this many display columns (Unicode codepoints). When the budget is greater than 3 the truncated tail is replaced with ...; when it is 3 or less the text is cut at exactly the budget. Applied before overlays are resolved.

Implementations

impl TextPropertyEntry

pub fn text(text: impl Into<String>) -> Self

Create a new entry with just text

pub fn normalize_widths(&mut self)

Resolve segments (if any) into text plus inline overlays, then apply truncate_to_chars, then pad_to_chars, then convert any unit: Char overlays to byte offsets against the resulting text. Idempotent: an entry with no segments, pad/truncate hints, or char-unit overlays is left untouched.

Truncation rounds the byte cut to a UTF-8 codepoint boundary. Char-offset overlays beyond the resulting codepoint count are clamped to that count.

pub fn with_property(self, key: impl Into<String>, value: Value) -> Self

Add a property

pub fn with_properties(self, props: HashMap<String, Value>) -> Self

Set multiple properties

pub fn with_style(self, style: OverlayOptions) -> Self

Set whole-entry styling

pub fn with_inline_overlay( self, start: usize, end: usize, style: OverlayOptions, ) -> Self

Add a sub-range inline overlay

pub fn with_segment( self, text: impl Into<String>, style: Option<OverlayOptions>, ) -> Self

Push a styled segment. After normalize_widths runs, the segment becomes part of text plus a Char-unit InlineOverlay covering it (when style is set).

Trait Implementations

impl Clone for TextPropertyEntry

fn clone(&self) -> TextPropertyEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextPropertyEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextPropertyEntry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TextPropertyEntry

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for TextPropertyEntry

type WithoutGenerics = TextPropertyEntry

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = TextPropertyEntry

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.