Struct TrArgs 

pub struct TrArgs { /* private fields */ }

A message with arguments: one concrete type, whatever the arity, so that a call site instantiates no generic.

Implementations

impl TrArgs

pub fn to_string(&self) -> String

Available on crate feature native, or (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos) only.

The message’s text in the language in force (the one lookup, above), isolated as that language’s side says: the Default Bidi Strategy for a request’s or a page’s catalog, and the store’s setting natively (mf2::native::set_bidi), off until set. to_plain_string is the form for text a program consumes.

The text Display writes, without core::fmt.

Panics

In a build whose only mode is native, before mf2::native::install (outside with_locale).

pub fn to_plain_string(&self) -> String

Available on crate feature native, or (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos) only.

The same text with no bidi isolation, for a String a program consumes — a comparison, the clipboard, a file — where U+2066–U+2069 would be invisible junk.

Panics

As to_string.

pub fn to_cow(&self) -> Cow<'static, str>

Available on crate feature native, or (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos) only.

The text to_string returns, borrowed from the executable when the message is simple and its catalog is the native store’s: no copy, no allocation. Otherwise it is owned.

Panics

As to_string.

pub fn to_display_string(&self) -> String

Available on (crate feature native, or (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos)) and (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos) only.

A synonym of to_string, kept from when to_string() was plain.

impl TrArgs

pub const fn id(&self) -> MsgId

The message’s id.

pub fn args(&self) -> &[ArgValue]

The arguments, in slot order.

pub fn write( &self, f: &Formatter<'_>, out: &mut dyn Sink, errs: &mut dyn ErrorSink, )

Formats it into out, reporting errors to errs.

pub fn parts( &self, f: &Formatter<'_>, out: &mut dyn PartSink, errs: &mut dyn ErrorSink, )

Formats it to parts.

pub fn format(&self, f: &Formatter<'_>) -> String

Its text, with the errors discarded.

Trait Implementations

impl AddAnyAttr for TrArgs

Available on crate features csr or hydrate or ssr only.

type Output<SomeNewAttr: Attribute> = TrArgs

The new type once the attribute has been added.

fn add_any_attr<NewAttr: Attribute>( self, _attr: NewAttr, ) -> Self::Output<NewAttr>

Adds an attribute to the view.

impl AttributeValue for TrArgs

Available on crate features csr or hydrate or ssr only.

type State = TrAttrState

The state that should be retained between building and rebuilding.

type AsyncOutput = TrArgs

The type once all async data have loaded.

type Cloneable = TrArgs

A version of the value that can be cloned. This can be the same type, or a reference-counted type. Generally speaking, this does not need to refer to the same data, but should behave in the same way. So for example, making an event handler cloneable should probably make it reference-counted (so that a FnMut() continues mutating the same closure), but making a String cloneable does not necessarily need to make it an Arc<str>, as two different clones of a String will still have the same value.

type CloneableOwned = TrArgs

A cloneable type that is also 'static. This is used for spreading across types when the spreadable attribute needs to be owned. In some cases (&'a str to Arc<str>, etc.) the owned cloneable type has worse performance than the cloneable type, so they are separate.

fn html_len(&self) -> usize

An approximation of the actual length of this attribute in HTML.

fn to_html(self, key: &str, buf: &mut String)

Renders the attribute value to HTML.

fn to_template(_key: &str, _buf: &mut String)

Renders the attribute value to HTML for a <template>.

fn hydrate<const FROM_SERVER: bool>( self, key: &str, el: &Element, ) -> Self::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.

fn build(self, el: &Element, key: &str) -> Self::State

Adds this attribute to the element during client-side rendering.

fn rebuild(self, key: &str, state: &mut Self::State)

Applies a new value for the attribute.

fn into_cloneable(self) -> Self::Cloneable

Converts this attribute into an equivalent that can be cloned.

fn into_cloneable_owned(self) -> Self::CloneableOwned

Converts this attributes into an equivalent that can be cloned and is 'static.

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

fn resolve(self) -> impl Future<Output = Self::AsyncOutput> + Send

“Resolves” this into a form that is not waiting for any asynchronous data.

impl Clone for TrArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrArgs

TrArgs { id: MsgId(n), args: [..] }.

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

Formats the value using the given formatter.

impl Display for TrArgs

Available on crate feature native, or (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos) only.

The text to_cow gives, padded when the format asks ({:<12}).

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

Formats the value using the given formatter.

impl From<&TrArgs> for Span<'static>

Available on crate feature ratatui only.

The message as one span, as by value.

fn from(description: &TrArgs) -> Span<'static>

Converts to this type from the input type.

impl From<&TrArgs> for Line<'static>

Available on crate feature ratatui only.

The message as one line, as by value.

fn from(description: &TrArgs) -> Line<'static>

Converts to this type from the input type.

impl From<&TrArgs> for Text<'static>

Available on crate feature ratatui only.

The message as text, as by value.

fn from(description: &TrArgs) -> Text<'static>

Converts to this type from the input type.

impl From<Tr> for TrArgs

fn from(t: Tr) -> TrArgs

Converts to this type from the input type.

impl From<TrArgs> for String

Available on crate feature native, or (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos) only.

fn from(description: TrArgs) -> String

Converts to this type from the input type.

impl From<TrArgs> for Span<'static>

Available on crate feature ratatui only.

The message as one span: its lines joined with a space, its markup flattened (a span has one style).

fn from(description: TrArgs) -> Span<'static>

Converts to this type from the input type.

impl From<TrArgs> for Line<'static>

Available on crate feature ratatui only.

The message as one line, its markup as the theme’s styles, its lines joined with a space.

fn from(description: TrArgs) -> Line<'static>

Converts to this type from the input type.

impl From<TrArgs> for Text<'static>

Available on crate feature ratatui only.

The message as text, its markup as the theme’s styles: a new line at each line break.

fn from(description: TrArgs) -> Text<'static>

Converts to this type from the input type.

impl From<TrArgs> for TextProp

Available on crate features csr or hydrate or ssr only.

Derived: re-read after a locale switch (client), captured for the request (server).

fn from(description: TrArgs) -> TextProp

Converts to this type from the input type.

impl From<TrArgs> for Signal<String>

Available on crate features csr or hydrate or ssr only.

Derived, like TextProp.

fn from(description: TrArgs) -> Signal<String>

Converts to this type from the input type.

impl From<TrArgs> for Oco<'static, str>

Available on crate features csr or hydrate or ssr only.

Not derived: an Oco is a value, so this is the message’s text now. It is the cheapest prop — and the one a component holds across a locale switch without noticing, which is why #[prop(into)] TextProp is what the documentation steers to.

fn from(description: TrArgs) -> Oco<'static, str>

Converts to this type from the input type.

impl IntoProperty for TrArgs

Available on crate features csr or hydrate or ssr only.

type State = TrAttrState

The view state retained between building and rebuilding.

type Cloneable = TrArgs

An equivalent value that can be cloned.

type CloneableOwned = TrArgs

An equivalent value that can be cloned and is 'static.

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, key: &str, ) -> Self::State

Adds the property on an element created from HTML.

fn build(self, el: &Element, key: &str) -> Self::State

Adds the property during client-side rendering.

fn rebuild(self, state: &mut Self::State, key: &str)

Updates the property with a new value.

fn into_cloneable(self) -> Self::Cloneable

Converts this to a cloneable type.

fn into_cloneable_owned(self) -> Self::CloneableOwned

Converts this to a cloneable, owned type.

impl Message for TrArgs

fn write(&self, f: &Formatter<'_>, out: &mut dyn Sink, errs: &mut dyn ErrorSink)

Formats it into out, reporting errors to errs.

fn parts( &self, f: &Formatter<'_>, out: &mut dyn PartSink, errs: &mut dyn ErrorSink, )

Formats it to parts — its markup among them — into out.

impl Render for TrArgs

Available on crate features csr or hydrate or ssr only.

type State = TrState

The “view state” for this type, which can be retained between updates.

fn build(self) -> Self::State

Creates the view for the first time, without hydrating from existing HTML.

fn rebuild(self, state: &mut Self::State)

Updates the view with new data.

impl RenderHtml for TrArgs

Available on crate features csr or hydrate or ssr only.

const MIN_LENGTH: usize = 0

The minimum length of HTML created when this view is rendered.

type AsyncOutput = TrArgs

The type of the view after waiting for all asynchronous data to load.

type Owned = TrArgs

An equivalent value that is 'static.

fn dry_resolve(&mut self)

“Runs” the view without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

fn resolve(self) -> impl Future<Output = Self::AsyncOutput> + Send

Waits for any asynchronous sections of the view to load and returns the output.

fn html_len(&self) -> usize

An estimated length for this view, when rendered to HTML.

fn to_html_with_buf( self, buf: &mut String, position: &mut Position, flags: RenderFlags, extra_attrs: Vec<AnyAttribute>, )

Renders a view to HTML, writing it into the given buffer.

fn hydrate<const FROM_SERVER: bool>( self, cursor: &Cursor, position: &PositionState, ) -> Self::State

Makes a set of DOM nodes rendered from HTML interactive.

fn into_owned(self) -> Self::Owned

Convert into the equivalent value that is 'static.

const EXISTS: bool = true

Whether this should actually exist in the DOM, if it is the child of an element.

fn to_html(self) -> String

where Self: Sized,

Renders a view to an HTML string.

fn to_html_branching(self) -> String

where Self: Sized,

Renders a view to HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn to_html_stream_in_order(self) -> StreamBuilder

where Self: Sized,

Renders a view to an in-order stream of HTML.

fn to_html_stream_in_order_branching(self) -> StreamBuilder

where Self: Sized,

Renders a view to an in-order stream of HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn to_html_stream_out_of_order(self) -> StreamBuilder

where Self: Sized,

Renders a view to an out-of-order stream of HTML.

fn to_html_stream_out_of_order_branching(self) -> StreamBuilder

where Self: Sized,

Renders a view to an out-of-order stream of HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn to_html_async_with_buf<const OUT_OF_ORDER: bool>( self, buf: &mut StreamBuilder, position: &mut Position, flags: RenderFlags, extra_attrs: Vec<AnyAttribute>, )

where Self: Sized,

Renders a view into a buffer of (synchronous or asynchronous) HTML chunks.

fn hydrate_async( self, cursor: &Cursor, position: &PositionState, ) -> impl Future<Output = Self::State>

Asynchronously makes a set of DOM nodes rendered from HTML interactive.

fn hydrate_from<const FROM_SERVER: bool>(self, el: &Element) -> Self::State

where Self: Sized,

Hydrates using RenderHtml::hydrate, beginning at the given element.

fn hydrate_from_position<const FROM_SERVER: bool>( self, el: &Element, position: Position, ) -> Self::State

where Self: Sized,

Hydrates using RenderHtml::hydrate, beginning at the given element and position.

impl Styled for TrArgs

Available on crate feature ratatui only.

Styled as its Line, so Ratatui’s Stylize works: the line keeps the message’s own markup styles, over the call’s.

type Item = Line<'static>

fn style(&self) -> Style

Returns the style of the object.

fn set_style<S: Into<Style>>(self, style: S) -> Line<'static>

Sets the style of the object.

impl ToTemplate for TrArgs

Available on crate features csr or hydrate or ssr only.

const TEMPLATE: &'static str = " <!>"

The HTML content of the static template.

fn to_template( buf: &mut String, _class: &mut String, _style: &mut String, _inner_html: &mut String, position: &mut Position, )

Renders a view type to a template. This does not take actual view data, but can be used for constructing part of an HTML <template> that corresponds to a view of a particular type.

const CLASS: &'static str = ""

The class attribute content known at compile time.

const STYLE: &'static str = ""

The style attribute content known at compile time.

const LEN: usize = _

The length of the template.

fn to_template_attribute( buf: &mut String, class: &mut String, style: &mut String, inner_html: &mut String, position: &mut Position, )

Renders a view type to a template in attribute position.

impl Widget for TrArgs

Available on crate feature ratatui only.

Drawn as its Text.

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.