Struct LangString 

pub struct LangString { /* private fields */ }

Language string.

A language string is a string tagged with language and reading direction information.

A valid language string is associated to either a language tag or a direction, or both.

Implementations

impl LangString

pub fn new( data: String, language: Option<LenientLangTagBuf>, direction: Option<Direction>, ) -> Result<Self, InvalidLangString>

Create a new language string.

Errors

Returns an error when the input is not valid for this type.

pub fn with_language(data: String, language: LenientLangTagBuf) -> Self

Total constructor: build a language string with a known language tag.

pub fn with_direction(data: String, direction: Direction) -> Self

Total constructor: build a language string with a known direction.

pub fn with_language_and_direction( data: String, language: LenientLangTagBuf, direction: Direction, ) -> Self

Total constructor: build a language string with both a language tag and a direction.

pub fn into_parts( self, ) -> (String, Option<LenientLangTagBuf>, Option<Direction>)

Consumes the language string, returning its string data, language tag and base direction.

pub fn parts(&self) -> (&str, Option<&LenientLangTagBuf>, Option<&Direction>)

Returns the string data, language tag and base direction.

pub fn as_str(&self) -> &str

Reference to the underlying str.

pub fn language(&self) -> Option<&LenientLangTag>

Gets the associated language tag, if any.

pub fn set_language( &mut self, language: Option<LenientLangTagBuf>, ) -> Result<(), MissingLangQualifier>

Sets the associated language tag.

If None is given, the direction must be set, otherwise this function will fail with a MissingLangQualifier error.

Errors

Returns an error when removing the language would leave a string with a direction but no language, which is not a valid language-tagged string.

pub fn direction(&self) -> Option<Direction>

Gets the associated direction, if any.

pub fn set_direction( &mut self, direction: Option<Direction>, ) -> Result<(), MissingLangQualifier>

Sets the associated direction.

If None is given, a language tag must be set, otherwise this function will fail with a MissingLangQualifier error.

Errors

Returns an error when removing the direction would leave a string with neither language nor direction.

pub fn set( &mut self, language: Option<LenientLangTagBuf>, direction: Option<Direction>, ) -> Result<(), MissingLangQualifier>

Set both the language tag and direction.

If both language and direction are None, this function will fail with a MissingLangQualifier error.

Errors

Returns an error when neither a language nor a direction is given, which no longer describes a language-tagged string.

pub fn as_lang_str(&self) -> LangStr<'_>

Returns a reference to this lang string as a LangStr.

Trait Implementations

impl Clone for LangString

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 LangString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LangString

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LangString

impl Hash for LangString

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 Ord for LangString

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for LangString

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LangString

fn partial_cmp(&self, other: &Self) -> 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 LangString

Available on crate feature serde only.

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 LangString