Struct Skew

pub struct Skew { /* private fields */ }

Represents value skews (see apply for more information).

Implementations

impl Skew

pub const DISABLED: Self

The disabled Self value.

pub const DEFAULT: Self

The default Self value.

pub const fn new(value: u64) -> Self

Constructs Self.

pub const fn get(self) -> u64

Returns the value wrapped in Self.

pub const fn disabled() -> Self

Returns the disabled Self.

pub fn apply(self, value: u64) -> impl Iterator<Item = u64>

Applies the skew to the given value.

Given some skew s and value n, this method returns an iterator that yields

n - s, n - s + 1, ..., n - 1, n, n + 1, ..., n + s - 1, n + s

Note

In case of overflows, the iterator will skip the values that would cause them.

Examples

Using zero to only accept the exact value:

use otp_std::Skew;

let skew = Skew::new(0);

let mut values = skew.apply(13);

assert_eq!(values.next(), Some(13));
assert_eq!(values.next(), None);

Using one:

use otp_std::Skew;

let skew = Skew::new(1);

let mut values = skew.apply(13);

assert_eq!(values.next(), Some(12));
assert_eq!(values.next(), Some(13));
assert_eq!(values.next(), Some(14));
assert_eq!(values.next(), None);

Overflow handling:

use otp_std::Skew;

let skew = Skew::new(1);

let value = u64::MAX;

let mut values = skew.apply(value);

assert_eq!(values.next(), Some(value - 1));
assert_eq!(values.next(), Some(value));
assert_eq!(values.next(), None);

Trait Implementations

impl Clone for Skew

fn clone(&self) -> Skew

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Skew

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

Formats the value using the given formatter.

impl Default for Skew

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Skew

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Skew

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

Formats the value using the given formatter.

impl From<Skew> for u64

fn from(skew: Skew) -> Self

Converts to this type from the input type.

impl From<u64> for Skew

fn from(value: u64) -> Self

Converts to this type from the input type.

impl FromStr for Skew

type Err = Error

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Skew

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 PartialEq for Skew

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Skew

impl Eq for Skew

impl StructuralPartialEq for Skew