Struct Smit 

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

A short marker a dog attaches to a sheep for shep flock to paint.

shep stores and prints it, never parses it: ▲ main@a1b2c3 is a deploy tool’s sentence.

The grammar: non-empty once whitespace is discounted, at most Self::MAX_CHARS characters, no char::is_control character, \u{1b} included. Refused, never repaired, and validated here rather than at the renderer: shep’s own output::width::sanitize_cell keeps a well-formed CSI sequence, since shep’s colouring is made of them.

Self::MAX_CHARS counts chars, not bytes: a byte cap would refuse a legitimate CJK smit at roughly a third of its apparent length.

Debug is derived: a smit carries no secret, so there is nothing to redact.

Example

use shep_core::protocol::Smit;

assert_eq!("▲ main@a1b2c3".parse::<Smit>()?.as_str(), "▲ main@a1b2c3");
assert!("\u{1b}[2Jgone".parse::<Smit>().is_err()); // no escapes

Implementations

impl Smit

pub const MAX_CHARS: usize = 48

The longest a smit may be, in characters.

pub fn as_str(&self) -> &str

The marker as text, exactly as its publisher sent it.

Trait Implementations

impl Clone for Smit

fn clone(&self) -> Smit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Smit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Smit

Validates on decode: a dog written in another language speaks this wire directly and never runs core::str::FromStr, so a derived impl would let \u{1b}[2J reach every listing built from a smit.

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

Deserialize this value from the given Serde deserializer.

impl Display for Smit

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

Formats the value using the given formatter.

impl Eq for Smit

impl FromStr for Smit

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

Errors

• SmitError::Empty if the text is nothing but whitespace.
• SmitError::TooLong if it is over Self::MAX_CHARS characters.
• SmitError::Unprintable if it holds a control character.

type Err = SmitError

The associated error which can be returned from parsing.

impl PartialEq for Smit

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Smit

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 Smit