std::num::FpCategory - Rust
Description: API documentation for the Rust `FpCategory` enum in crate `std`.
Keywords: rust, rustlang, rust-lang, FpCategory

# 1.0.0[−][src]Enum std::num::FpCategory

    pub enum FpCategory {
        Nan,
        Infinite,
        Zero,
        Subnormal,
        Normal,
    }

A classification of floating point numbers.

This `enum` is used as the return type for `f32::classify` and `f64::classify`. See their documentation for more.

# Examples

    use std::num::FpCategory;

    let num = 12.4_f32;
    let inf = f32::INFINITY;
    let zero = 0f32;
    let sub: f32 = 1.1754942e-38;
    let nan = f32::NAN;

    assert_eq!(num.classify(), FpCategory::Normal);
    assert_eq!(inf.classify(), FpCategory::Infinite);
    assert_eq!(zero.classify(), FpCategory::Zero);
    assert_eq!(nan.classify(), FpCategory::Nan);
    assert_eq!(sub.classify(), FpCategory::Subnormal);

Run

## Variants

`Nan`

"Not a Number", often obtained by dividing by zero.

`Infinite`

Positive or negative infinity.

`Zero`

Positive or negative zero.

`Subnormal`

De-normalized floating point representation (less precise than `Normal`).

`Normal`

A regular floating point number.

## Trait Implementations

### `impl Clone for FpCategory`[src]

#### `fn clone(&self) -> FpCategory`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`[src]

Performs copy-assignment from `source`. Read more

### `impl Copy for FpCategory`[src]

### `impl Debug for FpCategory`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

### `impl Eq for FpCategory`[src]

### `impl PartialEq<FpCategory> for FpCategory`[src]

#### `fn eq(&self, other: &FpCategory) -> bool`[src]

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

#### `#[must_use]fn ne(&self, other: &Rhs) -> bool`[src]

This method tests for `!=`.

### `impl StructuralEq for FpCategory`[src]

### `impl StructuralPartialEq for FpCategory`[src]

## Auto Trait Implementations

### `impl RefUnwindSafe for FpCategory`

### `impl Send for FpCategory`

### `impl Sync for FpCategory`

### `impl Unpin for FpCategory`

### `impl UnwindSafe for FpCategory`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

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

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.