Struct arel::value::sub_value::ValueSmallUnsigned

pub struct ValueSmallUnsigned(pub Option<u16>);

Tuple Fields

0: Option<u16>

Methods from Deref<Target = Option<u16>>

pub fn is_some(&self) -> bool

Returns true if the option is a Some value.

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_some(), true);

let x: Option<u32> = None;
assert_eq!(x.is_some(), false);

pub fn is_none(&self) -> bool

Returns true if the option is a None value.

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_none(), false);

let x: Option<u32> = None;
assert_eq!(x.is_none(), true);

pub fn as_ref(&self) -> Option<&T>

Converts from &Option<T> to Option<&T>.

Examples

Calculates the length of an Option<String> as an Option<usize> without moving the String. The map method takes the self argument by value, consuming the original, so this technique uses as_ref to first take an Option to a reference to the value inside the original.

let text: Option<String> = Some("Hello, world!".to_string());
// First, cast `Option<String>` to `Option<&String>` with `as_ref`,
// then consume *that* with `map`, leaving `text` on the stack.
let text_length: Option<usize> = text.as_ref().map(|s| s.len());
println!("still can print text: {text:?}");

pub fn as_mut(&mut self) -> Option<&mut T>

Converts from &mut Option<T> to Option<&mut T>.

Examples

let mut x = Some(2);
match x.as_mut() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, Some(42));

pub fn as_pin_ref(self: Pin<&Option<T>>) -> Option<Pin<&T>>

Converts from Pin<&Option<T>> to Option<Pin<&T>>.

pub fn as_pin_mut(self: Pin<&mut Option<T>>) -> Option<Pin<&mut T>>

Converts from Pin<&mut Option<T>> to Option<Pin<&mut T>>.

pub fn as_slice(&self) -> &[T]

Returns a slice of the contained value, if any. If this is None, an empty slice is returned. This can be useful to have a single type of iterator over an Option or slice.

Note: Should you have an Option<&T> and wish to get a slice of T, you can unpack it via opt.map_or(&[], std::slice::from_ref).

Examples

assert_eq!(
    [Some(1234).as_slice(), None.as_slice()],
    [&[1234][..], &[][..]],
);

The inverse of this function is (discounting borrowing) [_]::first:

for i in [Some(1234_u16), None] {
    assert_eq!(i.as_ref(), i.as_slice().first());
}

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice of the contained value, if any. If this is None, an empty slice is returned. This can be useful to have a single type of iterator over an Option or slice.

Note: Should you have an Option<&mut T> instead of a &mut Option<T>, which this method takes, you can obtain a mutable slice via opt.map_or(&mut [], std::slice::from_mut).

Examples

assert_eq!(
    [Some(1234).as_mut_slice(), None.as_mut_slice()],
    [&mut [1234][..], &mut [][..]],
);

The result is a mutable slice of zero or one items that points into our original Option:

let mut x = Some(1234);
x.as_mut_slice()[0] += 1;
assert_eq!(x, Some(1235));

The inverse of this method (discounting borrowing) is [_]::first_mut:

assert_eq!(Some(123).as_mut_slice().first_mut(), Some(&mut 123))

pub fn as_deref(&self) -> Option<&<T as Deref>::Target>

where T: Deref,

Converts from Option<T> (or &Option<T>) to Option<&T::Target>.

Leaves the original Option in-place, creating a new one with a reference to the original one, additionally coercing the contents via Deref.

Examples

let x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref(), Some("hey"));

let x: Option<String> = None;
assert_eq!(x.as_deref(), None);

pub fn as_deref_mut(&mut self) -> Option<&mut <T as Deref>::Target>

where T: DerefMut,

Converts from Option<T> (or &mut Option<T>) to Option<&mut T::Target>.

Leaves the original Option in-place, creating a new one containing a mutable reference to the inner type’s Deref::Target type.

Examples

let mut x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref_mut().map(|x| {
    x.make_ascii_uppercase();
    x
}), Some("HEY".to_owned().as_mut_str()));

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

Examples

let x = Some(4);
assert_eq!(x.iter().next(), Some(&4));

let x: Option<u32> = None;
assert_eq!(x.iter().next(), None);

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

Examples

let mut x = Some(4);
match x.iter_mut().next() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, Some(42));

let mut x: Option<u32> = None;
assert_eq!(x.iter_mut().next(), None);

pub fn insert(&mut self, value: T) -> &mut T

Inserts value into the option, then returns a mutable reference to it.

If the option already contains a value, the old value is dropped.

See also Option::get_or_insert, which doesn’t update the value if the option already contains Some.

Example

let mut opt = None;
let val = opt.insert(1);
assert_eq!(*val, 1);
assert_eq!(opt.unwrap(), 1);
let val = opt.insert(2);
assert_eq!(*val, 2);
*val = 3;
assert_eq!(opt.unwrap(), 3);

pub fn get_or_insert(&mut self, value: T) -> &mut T

Inserts value into the option if it is None, then returns a mutable reference to the contained value.

See also Option::insert, which updates the value even if the option already contains Some.

Examples

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert(5);
    assert_eq!(y, &5);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn get_or_insert_default(&mut self) -> &mut T

where T: Default,

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

Inserts the default value into the option if it is None, then returns a mutable reference to the contained value.

Examples

#![feature(option_get_or_insert_default)]

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert_default();
    assert_eq!(y, &0);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn get_or_insert_with<F>(&mut self, f: F) -> &mut T

where F: FnOnce() -> T,

Inserts a value computed from f into the option if it is None, then returns a mutable reference to the contained value.

Examples

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert_with(|| 5);
    assert_eq!(y, &5);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn take(&mut self) -> Option<T>

Takes the value out of the option, leaving a None in its place.

Examples

let mut x = Some(2);
let y = x.take();
assert_eq!(x, None);
assert_eq!(y, Some(2));

let mut x: Option<u32> = None;
let y = x.take();
assert_eq!(x, None);
assert_eq!(y, None);

pub fn take_if<P>(&mut self, predicate: P) -> Option<T>

where P: FnOnce(&mut T) -> bool,

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

Takes the value out of the option, but only if the predicate evaluates to true on a mutable reference to the value.

In other words, replaces self with None if the predicate returns true. This method operates similar to Option::take but conditional.

Examples

#![feature(option_take_if)]

let mut x = Some(42);

let prev = x.take_if(|v| if *v == 42 {
    *v += 1;
    false
} else {
    false
});
assert_eq!(x, Some(43));
assert_eq!(prev, None);

let prev = x.take_if(|v| *v == 43);
assert_eq!(x, None);
assert_eq!(prev, Some(43));

pub fn replace(&mut self, value: T) -> Option<T>

Replaces the actual value in the option by the value given in parameter, returning the old value if present, leaving a Some in its place without deinitializing either one.

Examples

let mut x = Some(2);
let old = x.replace(5);
assert_eq!(x, Some(5));
assert_eq!(old, Some(2));

let mut x = None;
let old = x.replace(3);
assert_eq!(x, Some(3));
assert_eq!(old, None);

Trait Implementations

impl<T> Add<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

Examples

use arel::prelude::*;
use arel::value::sub_value::ValueSmallUnsigned;
let v1: ValueSmallUnsigned = 1.into();
assert_eq!(v1 + 2, ValueSmallUnsigned(Some(3)));

let v1: ValueSmallUnsigned = None::<u16>.into();
assert_eq!(v1 + 2, ValueSmallUnsigned(Some(2)));

type Output = ValueSmallUnsigned

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for ValueSmallUnsigned

fn clone(&self) -> ValueSmallUnsigned

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValueSmallUnsigned

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

Formats the value using the given formatter.

impl Default for ValueSmallUnsigned

fn default() -> ValueSmallUnsigned

Returns the “default value” for a type.

impl Deref for ValueSmallUnsigned

type Target = Option<u16>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for ValueSmallUnsigned

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

Mutably dereferences the value.

impl<'de> Deserialize<'de> for ValueSmallUnsigned

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Div<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

Examples

use arel::prelude::*;
use arel::value::sub_value::ValueSmallUnsigned;
let v1: ValueSmallUnsigned = 1.into();
assert_eq!(v1 / 2, ValueSmallUnsigned(Some(0)));

let v1: ValueSmallUnsigned = None::<u16>.into();
assert_eq!(v1 / 2, ValueSmallUnsigned(Some(0)));

type Output = ValueSmallUnsigned

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T> DivAssign<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T> From<&T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned> + Clone,

Examples

Value

use arel::prelude::*;
use arel::value::sub_value::ValueSmallUnsigned;
let v: ValueSmallUnsigned = (&1).into();
assert_eq!(v, ValueSmallUnsigned(Some(1)));

fn from(val: &T) -> Self

Converts to this type from the input type.

impl<T> From<Option<T>> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

Examples

Value

use arel::prelude::*;
use arel::value::sub_value::ValueSmallUnsigned;
let v: ValueSmallUnsigned = Some(1).into();
assert_eq!(v, ValueSmallUnsigned(Some(1)));
let v: ValueSmallUnsigned = Some(&1).into();
assert_eq!(v, ValueSmallUnsigned(Some(1)));

fn from(val: Option<T>) -> Self

Converts to this type from the input type.

impl From<ValueSmallUnsigned> for Value

fn from(val: ValueSmallUnsigned) -> Self

Converts to this type from the input type.

impl From<u16> for ValueSmallUnsigned

Examples

Value

use arel::prelude::*;
use arel::value::sub_value::ValueSmallUnsigned;
let v: ValueSmallUnsigned = 1.into();
assert_eq!(v, ValueSmallUnsigned(Some(1)));

fn from(val: u16) -> Self

Converts to this type from the input type.

impl<T> Mul<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

Examples

use arel::prelude::*;
use arel::value::sub_value::ValueSmallUnsigned;
let v1: ValueSmallUnsigned = 1.into();
assert_eq!(v1 * 2, ValueSmallUnsigned(Some(2)));

let v1: ValueSmallUnsigned = None::<u16>.into();
assert_eq!(v1 * 2, ValueSmallUnsigned(Some(0)));

type Output = ValueSmallUnsigned

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T> MulAssign<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl PartialEq<Option<u16>> for ValueSmallUnsigned

fn eq(&self, other: &Option<u16>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u16> for ValueSmallUnsigned

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ValueSmallUnsigned

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Rem<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

Examples

use arel::prelude::*;
use arel::value::sub_value::ValueSmallUnsigned;
let v1: ValueSmallUnsigned = 1.into();
assert_eq!(v1 % 2, ValueSmallUnsigned(Some(1)));

let v1: ValueSmallUnsigned = None::<u16>.into();
assert_eq!(v1 % 2, ValueSmallUnsigned(Some(0)));

type Output = ValueSmallUnsigned

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T> RemAssign<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl Serialize for ValueSmallUnsigned

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Sub<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

Examples

use arel::prelude::*;
use arel::value::sub_value::ValueSmallUnsigned;
let v1: ValueSmallUnsigned = 3.into();
assert_eq!(v1 - 2, ValueSmallUnsigned(Some(1)));

let v1: ValueSmallUnsigned = None::<u16>.into();
assert_eq!(v1 - 0, ValueSmallUnsigned(Some(0)));

type Output = ValueSmallUnsigned

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<T> for ValueSmallUnsigned

where T: Into<ValueSmallUnsigned>,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<ValueSmallUnsigned> for Option<u16>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ValueSmallUnsigned> for u16

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for ValueSmallUnsigned