Struct Str

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

Subtype of Value that represents a string

Implementations

impl Str

pub fn substr(&self, index: RangeInclusive<&Value>) -> Result<&str, Error>

String indexing Returns a substring

Although this looks like the IndexingOperationExt trait, it is not because it returns a string instead of a value

pub fn mut_substr( &mut self, index: RangeInclusive<&Value>, ) -> Result<&mut str, Error>

Mutable string indexing Returns a mutable substring

Although this looks like the IndexingOperationExt trait, it is not because it returns a string instead of a value

pub fn set_substr( &mut self, index: RangeInclusive<&Value>, value: Value, ) -> Result<(), Error>

Replace a set of characters in the string

Although this looks like the IndexingOperationExt trait, it is not because it returns a string instead of a value

pub fn index_value_to_range( index: &Value, ) -> Result<RangeInclusive<Value>, Error>

Convert an index value to a range, useful for bridging the gap between the IndexingOperationExt trait and the substr functions Can fail if the index is not an array of integers, or if the array is empty

pub fn to_escaped_string(&self) -> String

Returns a quoted string, with , \n, \r, \t and “ escaped

Trait Implementations

impl Add for Str

type Output = Result<Str, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl ArithmeticOperationExt for Str

fn arithmetic_op( self, right: Self, operation: ArithmeticOperation, ) -> Result<Self, Error>

Perform an arithmetic operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned

fn arithmetic_neg(self) -> Result<Self, Error>

where Self: Sized,

Perform an arithmetic negation on a value This is equivalent to arithmetic_op with ArithmeticOperation::Negate but is provided for convenience

impl BooleanOperationExt for Str

fn boolean_op( self, right: Self, operation: BooleanOperation, ) -> Result<Value, Error>

Perform a boolean operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned

fn boolean_not(self) -> Result<Value, Error>

where Self: Sized,

Perform a boolean not on a value This is equivalent to boolean_op with BooleanOperation::Not but is provided for convenience

impl Clone for Str

fn clone(&self) -> Str

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Str

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

Formats the value using the given formatter.

impl Default for Str

fn default() -> Str

Returns the “default value” for a type.

impl DerefMut for Str

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Str

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Str

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

Formats the value using the given formatter.

impl From<&str> for Str

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Str> for Value

fn from(v: Str) -> Self

Converts to this type from the input type.

impl From<String> for Str

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for Str

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 IndexingOperationExt for Str

fn get_index(&self, index: &Value) -> Result<Value, Error>

Get a value from an index Returns a value, or an Error::Index if the index is not found

fn get_indices(&self, index: &Value) -> Result<Value, Error>

Get values from one or more indices Returns a vector of values, or an Error::Index if any of the indices are not found

impl Into<String> for Str

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl MatchingOperationExt for Str

fn matching_op( container: &Self, pattern: &Value, operation: MatchingOperation, ) -> Result<Value, Error>

where Self: Sized,

Perform a matching operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned

impl Neg for Str

type Output = Result<Str, Error>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Str

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Str

type Output = Result<Str, Error>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl TryFrom<Array> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Bool> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Fixed> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Float> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<I16> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<I32> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<I64> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<I8> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Object> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for Array

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for Bool

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for Fixed

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for Float

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for I16

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for I32

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for I64

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for I8

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for Object

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for Range

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for U16

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for U32

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for U64

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for U8

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<U16> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<U32> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<U64> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<U8> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Value> for Str

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl ValueTrait for Str

type Inner = String

The inner type of the value

fn new(inner: String) -> Self

Creates a new value from the given inner value

fn inner(&self) -> &String

Returns a reference to the inner value

fn inner_mut(&mut self) -> &mut String

Returns a mutable reference to the inner value

fn into_inner(self) -> String

Consumes the value and returns the inner value

impl Deref for Str

type Target = <Str as ValueTrait>::Inner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for Str

impl StructuralPartialEq for Str