Struct Tags 

pub struct Tags(/* private fields */);

The tag section of a message, in the order it arrived.

Order is kept rather than folded into a map because a round trip has to reproduce the line, and because a server may legally send the same key twice.

Implementations

impl Tags

pub fn parse(raw: &str) -> Self

Parse the raw tag section, without its leading @.

pub fn get(&self, key: &str) -> Option<&str>

The unescaped value of the last tag with this key, if it has one.

A key may legally appear twice, and the specification says to disregard all but the final occurrence. The duplicates are still kept so a line renders back exactly as it arrived.

pub fn contains(&self, key: &str) -> bool

True when a tag with this key is present, with or without a value.

pub fn set(&mut self, tag: Tag)

Add a tag, replacing any existing tag with the same key.

pub fn remove(&mut self, key: &str)

Remove every tag with this key.

pub fn is_empty(&self) -> bool

True when there are no tags, in which case the line carries no @ section.

pub fn len(&self) -> usize

How many tags are present.

pub fn iter(&self) -> Iter<'_, Tag>

Iterate the tags in wire order.

Trait Implementations

impl Clone for Tags

fn clone(&self) -> Tags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tags

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

Formats the value using the given formatter.

impl Default for Tags

fn default() -> Tags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tags

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Tags

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

Formats the value using the given formatter.

impl Eq for Tags

impl FromIterator<Tag> for Tags

fn from_iter<T: IntoIterator<Item = Tag>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Tags

type Item = &'a Tag

The type of the elements being iterated over.

type IntoIter = Iter<'a, Tag>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Tags

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tags

impl TS for Tags

const DOCS: Option<&'static str>

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

type WithoutGenerics = Tags

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.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> 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() -> String

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

fn inline() -> 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() -> 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<&'static Path>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> 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() -> 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_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_to_string() -> 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.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.