# [−] [src] Struct script::Num

    pub struct Num { /* fields omitted */ }

Script numeric

Numeric opcodes (`OP_1ADD`, etc) are restricted to operating on 4-byte integers. The semantics are subtle, though: operands must be in the range [-2^31 +1...2^31 -1], but results may overflow (and are valid as long as they are not used in a subsequent numeric operation). `CScriptNum` enforces those semantics by storing results as an int64 and allowing out-of-range values to be returned as a vector of bytes but throwing an exception if arithmetic is done or the result is interpreted as an integer.

## Methods

###

`impl Num`

[src]

####

`pub fn minimally_encode(data: &[u8], max_size: usize) -> Result<Self, Error>`

[src]

Reduce the data size to its minimal, and then try to convert it to a num.

####

`pub fn from_slice( data: &[u8], require_minimal: bool, max_size: usize ) -> Result<Self, Error>`

[src]

####
ⓘImportant traits for Bytes

### Important traits for Bytes

`impl Write for Bytes`

`pub fn to_bytes(&self) -> Bytes`

[src]

####

`pub fn is_negative(&self) -> bool`

[src]

####

`pub fn is_zero(&self) -> bool`

[src]

####

`pub fn abs(&self) -> Num`

[src]

## Trait Implementations

###

`impl Debug for Num`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl PartialEq for Num`

[src]

####

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

[src]

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

####

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

[src]

This method tests for `!=`.

###

`impl Eq for Num`

[src]

###

`impl PartialOrd for Num`

[src]

####

`fn partial_cmp(&self, other: &Num) -> Option<Ordering>`

[src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

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

[src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

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

[src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

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

[src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

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

[src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl Ord for Num`

[src]

####

`fn cmp(&self, other: &Num) -> Ordering`

[src]

This method returns an `Ordering` between `self` and `other`. Read more

####

`fn max(self, other: Self) -> Self`

1.21.0
[src]

Compares and returns the maximum of two values. Read more

####

`fn min(self, other: Self) -> Self`

1.21.0
[src]

Compares and returns the minimum of two values. Read more

###

`impl Clone for Num`

[src]

####

`fn clone(&self) -> Num`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl Copy for Num`

[src]

###

`impl From<bool> for Num`

[src]

####

`fn from(i: bool) -> Self`

[src]

Performs the conversion.

###

`impl From<u8> for Num`

[src]

####

`fn from(i: u8) -> Self`

[src]

Performs the conversion.

###

`impl From<u32> for Num`

[src]

####

`fn from(i: u32) -> Self`

[src]

Performs the conversion.

###

`impl From<usize> for Num`

[src]

####

`fn from(i: usize) -> Self`

[src]

Performs the conversion.

###

`impl From<i32> for Num`

[src]

####

`fn from(i: i32) -> Self`

[src]

Performs the conversion.

###

`impl From<i64> for Num`

[src]

####

`fn from(i: i64) -> Self`

[src]

Performs the conversion.

###

`impl From<Num> for i64`

[src]

####

`fn from(n: Num) -> Self`

[src]

Performs the conversion.

###

`impl From<Num> for u32`

[src]

####

`fn from(n: Num) -> Self`

[src]

Performs the conversion.

###

`impl From<Num> for usize`

[src]

####

`fn from(n: Num) -> Self`

[src]

Performs the conversion.

###

`impl BitAnd for Num`

[src]

#### `type Output = Self`

The resulting type after applying the `&` operator.

####

`fn bitand(self, rhs: Self) -> Self::Output`

[src]

Performs the `&` operation.

###

`impl Add for Num`

[src]

#### `type Output = Self`

The resulting type after applying the `+` operator.

####

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

[src]

Performs the `+` operation.

###

`impl Sub for Num`

[src]

#### `type Output = Self`

The resulting type after applying the `-` operator.

####

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

[src]

Performs the `-` operation.

###

`impl Neg for Num`

[src]

#### `type Output = Self`

The resulting type after applying the `-` operator.

####

`fn neg(self) -> Self::Output`

[src]

Performs the unary `-` operation.

###

`impl Div for Num`

[src]

#### `type Output = Self`

The resulting type after applying the `/` operator.

####

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

[src]

Performs the `/` operation.

###

`impl Rem for Num`

[src]

#### `type Output = Self`

The resulting type after applying the `%` operator.

####

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

[src]

Performs the `%` operation.

## Auto Trait Implementations

###

`impl Send for Num`

###

`impl Sync for Num`

## Blanket Implementations

###

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

[src]

#### `type Owned = T`

####

`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`)

recently added

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

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

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

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

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

The type returned in the event of a conversion error.

####

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

[src]

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

Performs the conversion.

###

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

[src]

####
ⓘImportant traits for &'a mut R

### Important traits for &'a mut R

`impl<'a, R> Read for &'a mut R where
R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

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

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

The type returned in the event of a conversion error.

####

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

[src]

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

Performs the conversion.

###

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

[src]

####
ⓘImportant traits for &'a mut R

### Important traits for &'a mut R

`impl<'a, R> Read for &'a mut R where
R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

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

this method will likely be replaced by an associated static

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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)