Struct cql_tiny_text::TinyText

pub struct TinyText(_);

Tuple wrapping String for working with TinyText values in a CQL database.

Limited in size to 255 * 4 = 1020 bytes.

Methods

impl TinyText

pub fn new() -> Self

Trait Implementations

impl Clone for TinyText

fn clone(&self) -> TinyText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CqlReadable for TinyText

fn read_from_db(
    db_location: &str,
    value_location: u64
) -> Result<Self::ValueType>

Reads the value stored in the given value_location in the given db_location (file path).

impl CqlStreamReadable for TinyText

fn read_to_stream(
    db_location: &str,
    stream: &mut dyn Write,
    value_location: u64,
    n_values: u64
) -> Result<()>

Reads n_values from the value_location in the given db_location (file path) to the given stream.

impl CqlType for TinyText

type ValueType = Self

The type of value to read/write from the database.

const VALUE_SIZE: usize

The (maximum) size of the value to read/write from the database.

impl CqlWritable for TinyText

fn write_to_db(
    db_location: &str,
    value_location: u64,
    input_value: Self::ValueType
) -> Result<()>

Writes the given input_value to the given value_location in the given db_location (file path).

impl Debug for TinyText

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

Formats the value using the given formatter.

impl Default for TinyText

fn default() -> TinyText

Returns the "default value" for a type.

impl Display for TinyText

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

Formats the value using the given formatter.

impl Eq for TinyText

impl From<TinyText> for String

fn from(text: TinyText) -> Self

Performs the conversion.

impl Hash for TinyText

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

fn cmp(&self, other: &TinyText) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<TinyText> for TinyText

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

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

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

This method tests for !=.

impl PartialOrd<TinyText> for TinyText

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for TinyText

impl StructuralPartialEq for TinyText

impl<'_> TryFrom<&'_ str> for TinyText

Attempts to convert the given &str to TinyText. Errors if the length of the &str excedes 1020 bytes.

Examples

use std::convert::TryFrom;

let small_string = "s".repeat(1020); // 1 byte per char
assert_eq!("s".repeat(1020), String::from(TinyText::try_from(small_string).unwrap()));

let big_string = "s".repeat(1021);
assert_eq!(Err(ValueTooLargeError), TinyText::try_from(big_string));

let small_utf8_string = "س".repeat(510); // 2 bytes per char
assert_eq!("س".repeat(510), String::from(TinyText::try_from(small_utf8_string).unwrap()));

let big_utf8_string = "س".repeat(511);
assert_eq!(Err(ValueTooLargeError), TinyText::try_from(big_utf8_string));

type Error = ValueTooLargeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for TinyText

Attempts to convert the given string to TinyText. Errors if the length of the String excedes 1020 bytes.

Errors

Will return a ValueTooLargeError if the given string is larger than 1020 bytes.

Examples

use std::convert::TryFrom;

let small_string = "s".repeat(1020); // 1 byte per char
assert_eq!("s".repeat(1020), String::from(TinyText::try_from(small_string).unwrap()));

let big_string = "s".repeat(1021);
assert_eq!(Err(ValueTooLargeError), TinyText::try_from(big_string));

let small_utf8_string = "س".repeat(510); // 2 bytes per char
assert_eq!("س".repeat(510), String::from(TinyText::try_from(small_utf8_string).unwrap()));

let big_utf8_string = "س".repeat(511);
assert_eq!(Err(ValueTooLargeError), TinyText::try_from(big_utf8_string));

type Error = ValueTooLargeError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.