Struct DecSixbit

pub struct DecSixbit { /* private fields */ }

The DecSixbit struct stores the encoded bytes and provides methods for accessing the encoded data and retrieving the original string.

Implementations

impl DecSixbit

pub fn new(str: &str) -> Result<Self, Error>

Creates a new DecSixbit instance by encoding the input string. Only accepts ASCII characters in the range 32-95 (space through underscore). Creates a new DecSixbit instance by encoding the input string.

Parameters

• str: The input string to encode. Must contain only ASCII characters in the range 32-95.

Errors

Returns an Error::InvalidCharacter if the input contains invalid characters.

Examples

use dec_sixbit::DecSixbit;

let sixbit = DecSixbit::new("HELLO").unwrap();

pub fn as_bytes(&self) -> &[u8]

Returns a reference to the encoded SIXBIT bytes.

Returns

A slice of bytes containing the SIXBIT-encoded data.

Examples

use dec_sixbit::DecSixbit;

let sixbit = DecSixbit::new("HELLO").unwrap();
let encoded = sixbit.as_bytes();

pub fn len(&self) -> usize

Returns the length of the original input string.

Returns

The number of characters in the original string before encoding.

Examples

use dec_sixbit::DecSixbit;

let sixbit = DecSixbit::new("HELLO").unwrap();
assert_eq!(sixbit.len(), 5);

pub fn is_empty(&self) -> bool

Checks if the encoded SIXBIT data is empty.

Returns

true if the original input string was empty, otherwise false.

Examples

use dec_sixbit::DecSixbit;

let sixbit = DecSixbit::new("").unwrap();
assert!(sixbit.is_empty());

pub fn try_from_slice(bytes: &[u8]) -> Result<Self, Error>

Attempts to create a DecSixbit instance from a slice of encoded bytes.

Parameters

• bytes: A slice of bytes containing SIXBIT-encoded data.

Returns

• Ok(Self) if the slice is successfully parsed.
• Err(Error) if the slice has an invalid format or contains invalid data.

pub fn from_slice(bytes: &[u8]) -> Self

Creates a DecSixbit instance from a slice of encoded bytes.

Parameters

• bytes: A slice of bytes containing SIXBIT-encoded data.

Panics

• Panics if the slice has an invalid format or contains invalid data.

pub fn get(&self, index: usize) -> Option<char>

Gets the character at the specified position.

Parameters

• index: The position of the character to retrieve.

Returns

An Option<char> which is Some(char) if the index is valid, or None otherwise.

Examples

use dec_sixbit::DecSixbit;

let sixbit = DecSixbit::new("HELLO").unwrap();
assert_eq!(sixbit.get(1), Some('E'));
assert_eq!(sixbit.get(5), None);

pub fn starts_with<P: AsRef<str>>(&self, prefix: P) -> bool

Checks if the string starts with the given prefix.

Parameters

• prefix: The prefix string to check.

Returns

true if the string starts with the given prefix, otherwise false.

Examples

use dec_sixbit::DecSixbit;

let sixbit = DecSixbit::new("HELLO").unwrap();
assert!(sixbit.starts_with("HE"));
assert!(!sixbit.starts_with("EL"));

pub fn ends_with<P: AsRef<str>>(&self, suffix: P) -> bool

Checks if the string ends with the given suffix.

Parameters

• suffix: The suffix string to check.

Returns

true if the string ends with the given suffix, otherwise false.

Examples

use dec_sixbit::DecSixbit;

let sixbit = DecSixbit::new("HELLO").unwrap();
assert!(sixbit.ends_with("LO"));
assert!(!sixbit.ends_with("HE"));

pub fn contains<P: AsRef<str>>(&self, substring: P) -> bool

Checks if the string contains the given substring.

Parameters

• substring: The substring to search for.

Returns

true if the string contains the given substring, otherwise false.

Examples

use dec_sixbit::DecSixbit;

let sixbit = DecSixbit::new("HELLO").unwrap();
assert!(sixbit.contains("ELL"));
assert!(!sixbit.contains("XYZ"));

Trait Implementations

impl AsRef<[u8]> for DecSixbit

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DecSixbit

fn clone(&self) -> DecSixbit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecSixbit

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

Formats the value using the given formatter.

impl Default for DecSixbit

fn default() -> DecSixbit

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DecSixbit

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

Deserialize this value from the given Serde deserializer.

impl Display for DecSixbit

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

Formats the value using the given formatter.

impl FromStr for DecSixbit

type Err = Error

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 Hash for DecSixbit

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 DecSixbit

fn cmp(&self, other: &DecSixbit) -> 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 PartialEq for DecSixbit

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

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

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

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for DecSixbit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Vec<u8>> for DecSixbit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for DecSixbit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for DecSixbit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DecSixbit

impl StructuralPartialEq for DecSixbit