Struct AllocMessage 

pub struct AllocMessage<const N: usize> { /* private fields */ }

A message format that can be allocated with a fixed number of placeholders.

Examples

use local_fmt::{AllocMessage, AllocMessageFormat};

let message = AllocMessage::<1>::new(vec![
    AllocMessageFormat::AllocText(String::from("Hello, ")),
    AllocMessageFormat::Placeholder(0),
]).unwrap();

let formatted = message.format(&["world"]);
assert_eq!(formatted, "Hello, world");

Implementations

impl<const N: usize> AllocMessage<N>

pub unsafe fn new_unchecked(format: Vec<AllocMessageFormat>) -> Self

Creates a new AllocMessage without checking the format.

Safety

The caller must ensure that the format is correct.

Examples

use local_fmt::{AllocMessage, AllocMessageFormat};

let message = unsafe {
    AllocMessage::<1>::new_unchecked(vec![
        AllocMessageFormat::AllocText(String::from("Hello, ")),
        AllocMessageFormat::Placeholder(0),
    ])
};

let formatted = message.format(&["world"]);
assert_eq!(formatted, "Hello, world");

pub fn new(format: Vec<AllocMessageFormat>) -> Result<Self, CreateMessageError>

Creates a new AllocMessage with format checking.

Returns an error if the format is invalid, such as missing placeholders.

Examples

use local_fmt::{AllocMessage, AllocMessageFormat, CreateMessageError};

let result = AllocMessage::<1>::new(vec![
    AllocMessageFormat::AllocText(String::from("Hello, ")),
    AllocMessageFormat::Placeholder(0),
]).unwrap();

let formatted = result.format(&["world"]);
assert_eq!(formatted, "Hello, world");

pub fn new_panic(format: Vec<AllocMessageFormat>) -> Self

pub fn format(&self, args: &[&str; N]) -> String

Formats the message with the provided arguments.

Arguments

• args - A slice of string references to be used as arguments in the placeholders.

Examples

use local_fmt::{AllocMessage, AllocMessageFormat};

let message = AllocMessage::<1>::new(vec![
    AllocMessageFormat::AllocText(String::from("Hello, ")),
    AllocMessageFormat::Placeholder(0),
]).unwrap();

let formatted = message.format(&["world"]);
assert_eq!(formatted, "Hello, world");

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn formats(&self) -> &Vec<AllocMessageFormat>

Trait Implementations

impl<const N: usize> Clone for AllocMessage<N>

fn clone(&self) -> AllocMessage<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for AllocMessage<N>

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

Formats the value using the given formatter.

impl<'de, const N: usize> Deserialize<'de> for AllocMessage<N>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Display for AllocMessage<N>

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

Formats the value using the given formatter.

impl<const N: usize> FromStr for AllocMessage<N>

type Err = CreateMessageError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const N: usize> Hash for AllocMessage<N>

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<const N: usize> Ord for AllocMessage<N>

fn cmp(&self, other: &AllocMessage<N>) -> 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<const N: usize> PartialEq for AllocMessage<N>

fn eq(&self, other: &AllocMessage<N>) -> 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<const N: usize> PartialOrd for AllocMessage<N>

fn partial_cmp(&self, other: &AllocMessage<N>) -> 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<const N: usize> Serialize for AllocMessage<N>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> Eq for AllocMessage<N>

impl<const N: usize> StructuralPartialEq for AllocMessage<N>