Struct to_binary::BinaryString

pub struct BinaryString(pub String);

BinaryString (0bString + 0bWString)

This Struct is the Main Struct for Dealing with Binary Strings and Binary Whitespace Strings.

It is a Tuple Struct that only has a Single, Public Field which is a String and can be accessed with self.0.

How To Access The String Field

use to_binary::BinaryString;

// Generate Binary String From &str
let x = BinaryString::from("Hello");

// Access The Public "String" Field And Assign It To bin_string using field
let bin_string: String = x.0;

// Print Out Information
println!("{}",bin_string);

Implementations

impl BinaryString

pub fn from_hex<T: AsRef<[u8]>>(n: T) -> Result<BinaryString, FromHexError>

Takes as input hexadecimal and outputs a Result containing a BinaryString and on Error, FromHexError

impl BinaryString

pub fn assert_binary(&self) -> bool

Asserts The Input Is A Binary String, or a string with only:

• 0
• 1

This function is the same as assert_binary_string() just with a different name

pub fn assert_binary_string(&self) -> bool

Asserts the Input Is A Binary String, or a String with only:

• 0
• 1
• No Whitespace

pub fn assert_binary_whitespace(&self) -> bool

Asserts The Input Is A Binary Whitespace String, or a String with only:

• 0
• 1
• whitespace

TODO: Add a check for whitespace to be every 8th character

pub fn assert_bytes(&self) -> bool

Asserts The Input Has (8 * n) bits or contains full bytes using the remainder function

This function calls the bits() method to retrieve the number of bits then does operation % 8 and compares it against 0

pub fn assert_bit_length(&self, len: usize) -> bool

Asserts The Number of Bits In The String

The function bits() is called to compare to the parameter

pub fn assert_byte_length(&self, len: usize) -> bool

Asserts The Number of Bytes In The String

The function bytes() is called to compare to the parameter

pub fn bits(&self) -> Result<usize, BinaryError>

Count number of bits for both a "Binary String" and "Binary Whitespace String" and returns a Result of either a usize or a BinaryError

pub fn bytes(&self) -> Result<usize, BinaryError>

Count number of bytes for both a "Binary String" and "Binary Whitespace String" and returns a Result of either a usize or on error, empty response

pub fn remove_spaces(&self) -> BinaryString

Removes All Whitespace From Binary String And Returns A BinaryString

pub fn add_spaces(&self) -> Result<BinaryString, BinaryError>

Adds Whitespace Between Every Byte (8 bits)

Example Usage

// Imports
use to_binary::{BinaryString,BinaryError};
 
// Generate `BinaryString` from &str "Test String"
let x = BinaryString::from("Test String");
 
// Returns a `BinaryString` With Spaces Between Every Byte (8 bits)
let bin_with_spaces = x.add_spaces().unwrap();
 

Trait Implementations

impl Clone for BinaryString

fn clone(&self) -> BinaryString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryString

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

Formats the value using the given formatter.

impl Default for BinaryString

fn default() -> BinaryString

Returns the "default value" for a type.

impl Display for BinaryString

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

Formats the value using the given formatter.

impl<'_> From<&'_ [u8]> for BinaryString

fn from(byte_slice: &[u8]) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for BinaryString

fn from(n: &str) -> Self

Performs the conversion.

impl From<[u8; 32]> for BinaryString

fn from(array: [u8; 32]) -> Self

Performs the conversion.

impl From<String> for BinaryString

fn from(n: String) -> Self

Performs the conversion.

impl From<Vec<u8>> for BinaryString

fn from(bytes: Vec<u8>) -> BinaryString

Performs the conversion.

impl From<u8> for BinaryString

fn from(byte: u8) -> BinaryString

Performs the conversion.

impl Hash for BinaryString

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<BinaryString> for BinaryString

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<BinaryString> for BinaryString

fn partial_cmp(&self, other: &BinaryString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &BinaryString) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &BinaryString) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &BinaryString) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &BinaryString) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BinaryString