Skip to main content

PutMode

Enum PutMode 

Source
pub enum PutMode {
    Raise,
    Wrap,
    Clip,
}
Expand description

Out-of-bounds index behaviour for MaskedArray::put, mirroring numpy’s mode keyword ({'raise', 'wrap', 'clip'}, numpy/ma/core.py:4852).

Variants§

§

Raise

'raise' — an out-of-range index returns IndexOutOfBounds.

§

Wrap

'wrap' — indices wrap around modulo the length (Python modulo, so a negative index wraps from the end).

§

Clip

'clip' — indices are clamped into [0, len); negatives clip to 0.

Implementations§

Source§

impl PutMode

Source

pub fn parse(s: &str) -> FerrayResult<Self>

Parse the numpy mode string. An unrecognised mode mirrors numpy’s ValueError (raised by np.put for a bad mode).

§Errors

Returns FerrayError::InvalidValue for any string other than "raise", "wrap", or "clip".

Trait Implementations§

Source§

impl Clone for PutMode

Source§

fn clone(&self) -> PutMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PutMode

Source§

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

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

impl PartialEq for PutMode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Copy for PutMode

Source§

impl Eq for PutMode

Source§

impl StructuralPartialEq for PutMode

Auto Trait Implementations§

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> 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.