Skip to main content

Position

Struct Position 

Source
pub struct Position<T> {
    pub index: usize,
    pub value: T,
}
Expand description

Position.

This data type attaches an index to a value, indicating its position within a sorted stream. It is primarily used in the context of Stream::sort, which keeps an internal store of items and updates their positions as the items entering the stream change.

Note that ordering of positions is determined by their index, and in case a tie-breaker is necessary, by the value itself.

Fields§

§index: usize

Index in sort order.

§value: T

Associated value.

Implementations§

Source§

impl<T> Position<T>

Source

pub fn new(index: usize, value: T) -> Self

Creates a position.

§Examples
use zrx_stream::value::Position;

// Create position
let position = Position::new(0, "a");
Source

pub fn into_parts(self) -> (usize, T)

Returns the index and associated value, consuming the position.

§Examples
use zrx_stream::value::Position;

// Create position
let position = Position::new(0, "a");
assert_eq!(
    position.into_parts(),
    (0, "a"),
);
Source

pub fn into_value(self) -> T

Returns the associated value, consuming the position.

use zrx_stream::value::Position;

// Create position
let position = Position::new(0, "a");
assert_eq!(position.into_value(), "a");

Trait Implementations§

Source§

impl<T: Clone> Clone for Position<T>

Source§

fn clone(&self) -> Position<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Position<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Ord> Ord for Position<T>

Source§

fn cmp(&self, other: &Position<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq> PartialEq for Position<T>

Source§

fn eq(&self, other: &Position<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: PartialOrd> PartialOrd for Position<T>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Eq> Eq for Position<T>

Source§

impl<T> StructuralPartialEq for Position<T>

Source§

impl<T> Value for Position<T>
where T: Value,

Auto Trait Implementations§

§

impl<T> Freeze for Position<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Position<T>
where T: RefUnwindSafe,

§

impl<T> Send for Position<T>
where T: Send,

§

impl<T> Sync for Position<T>
where T: Sync,

§

impl<T> Unpin for Position<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Position<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Position<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoReport<T> for T
where T: Value,

Source§

fn into_report(self) -> Result<Report<T>, Error>

Creates a report from a value T and wraps it in a result.

Source§

impl<T, E> IntoReport<T, E> for T
where E: Error,

Source§

fn into_report(self) -> Result<Report<T>, E>

Creates a report from a value T and wraps it in a result.

§Examples
use std::io::Error;
use zrx_diagnostic::report::IntoReport;

// Define function returning a value
fn f() -> impl IntoReport<i32, Error> {
    42
}

// Invoke function and create report
let res = f().into_report();
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ValueExt for T
where T: Value,

Source§

fn with_diagnostics<D>(self, diagnostics: D) -> Report<Self>

Adds diagnostics to the value. Read more
Source§

impl<T> Value for T
where T: Debug + 'static,