Primitive Type i161.0.0 [−]

The 16-bit signed integer type.

See also the std::i16 module.

However, please note that examples are shared between primitive integer types. So it's normal if you see usage of types like i32 in there.

Methods

`impl i16`
[src]

`pub const fn min_value() -> i16`
[src]

Returns the smallest value that can be represented by this integer type.

Examples

Basic usage:

assert_eq!(i8::min_value(), -128);Run

`pub const fn max_value() -> i16`
[src]

Returns the largest value that can be represented by this integer type.

Examples

Basic usage:

assert_eq!(i8::max_value(), 127);Run

`pub fn from_str_radix(src: &str, radix: u32) -> Result<i16, ParseIntError>`
[src]

Converts a string slice in a given base to an integer.

The string is expected to be an optional + or - sign followed by digits. Leading and trailing whitespace represent an error. Digits are a subset of these characters, depending on radix:

0-9
a-z
A-Z

Panics

This function panics if radix is not in the range from 2 to 36.

Examples

Basic usage:

assert_eq!(i32::from_str_radix("A", 16), Ok(10));Run

`pub fn count_ones(self) -> u32`
[src]

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

let n = -0b1000_0000i8;

assert_eq!(n.count_ones(), 1);Run

`pub fn count_zeros(self) -> u32`
[src]

Returns the number of zeros in the binary representation of self.

Examples

Basic usage:

let n = -0b1000_0000i8;

assert_eq!(n.count_zeros(), 7);Run

`pub fn leading_zeros(self) -> u32`
[src]

Returns the number of leading zeros in the binary representation of self.

Examples

Basic usage:

let n = -1i16;

assert_eq!(n.leading_zeros(), 0);Run

`pub fn trailing_zeros(self) -> u32`
[src]

Returns the number of trailing zeros in the binary representation of self.

Examples

Basic usage:

let n = -4i8;

assert_eq!(n.trailing_zeros(), 2);Run

`pub fn rotate_left(self, n: u32) -> i16`
[src]

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn't the same operation as <<!

Examples

Basic usage:

let n = 0x0123456789ABCDEFi64;
let m = -0x76543210FEDCBA99i64;

assert_eq!(n.rotate_left(32), m);Run

`pub fn rotate_right(self, n: u32) -> i16`
[src]

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn't the same operation as >>!

Examples

Basic usage:

let n = 0x0123456789ABCDEFi64;
let m = -0xFEDCBA987654322i64;

assert_eq!(n.rotate_right(4), m);Run

`pub fn swap_bytes(self) -> i16`
[src]

Reverses the byte order of the integer.

Examples

Basic usage:

let n: i16 = 0b0000000_01010101;
assert_eq!(n, 85);

let m = n.swap_bytes();

assert_eq!(m, 0b01010101_00000000);
assert_eq!(m, 21760);Run

`pub fn from_be(x: i16) -> i16`
[src]

Converts an integer from big endian to the target's endianness.

On big endian this is a no-op. On little endian the bytes are swapped.

Examples

Basic usage:

let n = 0x0123456789ABCDEFi64;

if cfg!(target_endian = "big") {
    assert_eq!(i64::from_be(n), n)
} else {
    assert_eq!(i64::from_be(n), n.swap_bytes())
}Run

`pub fn from_le(x: i16) -> i16`
[src]

Converts an integer from little endian to the target's endianness.

On little endian this is a no-op. On big endian the bytes are swapped.

Examples

Basic usage:

let n = 0x0123456789ABCDEFi64;

if cfg!(target_endian = "little") {
    assert_eq!(i64::from_le(n), n)
} else {
    assert_eq!(i64::from_le(n), n.swap_bytes())
}Run

`pub fn to_be(self) -> i16`
[src]

Converts self to big endian from the target's endianness.

On big endian this is a no-op. On little endian the bytes are swapped.

Examples

Basic usage:

let n = 0x0123456789ABCDEFi64;

if cfg!(target_endian = "big") {
    assert_eq!(n.to_be(), n)
} else {
    assert_eq!(n.to_be(), n.swap_bytes())
}Run

`pub fn to_le(self) -> i16`
[src]

Converts self to little endian from the target's endianness.

On little endian this is a no-op. On big endian the bytes are swapped.

Examples

Basic usage:

let n = 0x0123456789ABCDEFi64;

if cfg!(target_endian = "little") {
    assert_eq!(n.to_le(), n)
} else {
    assert_eq!(n.to_le(), n.swap_bytes())
}Run

`pub fn checked_add(self, rhs: i16) -> Option<i16>`
[src]

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(7i16.checked_add(32760), Some(32767));
assert_eq!(8i16.checked_add(32760), None);Run

`pub fn checked_sub(self, rhs: i16) -> Option<i16>`
[src]

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((-127i8).checked_sub(1), Some(-128));
assert_eq!((-128i8).checked_sub(1), None);Run

`pub fn checked_mul(self, rhs: i16) -> Option<i16>`
[src]

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(6i8.checked_mul(21), Some(126));
assert_eq!(6i8.checked_mul(22), None);Run

`pub fn checked_div(self, rhs: i16) -> Option<i16>`
[src]

Checked integer division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

Examples

Basic usage:

assert_eq!((-127i8).checked_div(-1), Some(127));
assert_eq!((-128i8).checked_div(-1), None);
assert_eq!((1i8).checked_div(0), None);Run

`pub fn checked_rem(self, rhs: i16) -> Option<i16>`
1.7.0
[src]

Checked integer remainder. Computes self % rhs, returning None if rhs == 0 or the division results in overflow.

Examples

Basic usage:

use std::i32;

assert_eq!(5i32.checked_rem(2), Some(1));
assert_eq!(5i32.checked_rem(0), None);
assert_eq!(i32::MIN.checked_rem(-1), None);Run

`pub fn checked_neg(self) -> Option<i16>`
1.7.0
[src]

Checked negation. Computes -self, returning None if self == MIN.

Examples

Basic usage:

use std::i32;

assert_eq!(5i32.checked_neg(), Some(-5));
assert_eq!(i32::MIN.checked_neg(), None);Run

`pub fn checked_shl(self, rhs: u32) -> Option<i16>`
1.7.0
[src]

Checked shift left. Computes self << rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(0x10i32.checked_shl(4), Some(0x100));
assert_eq!(0x10i32.checked_shl(33), None);Run

`pub fn checked_shr(self, rhs: u32) -> Option<i16>`
1.7.0
[src]

Checked shift right. Computes self >> rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(0x10i32.checked_shr(4), Some(0x1));
assert_eq!(0x10i32.checked_shr(33), None);Run

`pub fn checked_abs(self) -> Option<i16>`
1.13.0
[src]

Checked absolute value. Computes self.abs(), returning None if self == MIN.

Examples

Basic usage:

use std::i32;

assert_eq!((-5i32).checked_abs(), Some(5));
assert_eq!(i32::MIN.checked_abs(), None);Run

`pub fn saturating_add(self, rhs: i16) -> i16`
[src]

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(100i8.saturating_add(1), 101);
assert_eq!(100i8.saturating_add(127), 127);Run

`pub fn saturating_sub(self, rhs: i16) -> i16`
[src]

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(100i8.saturating_sub(127), -27);
assert_eq!((-100i8).saturating_sub(127), -128);Run

`pub fn saturating_mul(self, rhs: i16) -> i16`
1.7.0
[src]

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

use std::i32;

assert_eq!(100i32.saturating_mul(127), 12700);
assert_eq!((1i32 << 23).saturating_mul(1 << 23), i32::MAX);
assert_eq!((-1i32 << 23).saturating_mul(1 << 23), i32::MIN);Run

`pub fn wrapping_add(self, rhs: i16) -> i16`
[src]

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(100i8.wrapping_add(27), 127);
assert_eq!(100i8.wrapping_add(127), -29);Run

`pub fn wrapping_sub(self, rhs: i16) -> i16`
[src]

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(0i8.wrapping_sub(127), -127);
assert_eq!((-2i8).wrapping_sub(127), 127);Run

`pub fn wrapping_mul(self, rhs: i16) -> i16`
[src]

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(10i8.wrapping_mul(12), 120);
assert_eq!(11i8.wrapping_mul(12), -124);Run

`pub fn wrapping_div(self, rhs: i16) -> i16`
1.2.0
[src]

Wrapping (modular) division. Computes self / rhs, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Panics

This function will panic if rhs is 0.

Examples

Basic usage:

assert_eq!(100u8.wrapping_div(10), 10);
assert_eq!((-128i8).wrapping_div(-1), -128);Run

`pub fn wrapping_rem(self, rhs: i16) -> i16`
1.2.0
[src]

Wrapping (modular) remainder. Computes self % rhs, wrapping around at the boundary of the type.

Such wrap-around never actually occurs mathematically; implementation artifacts make x % y invalid for MIN / -1 on a signed type (where MIN is the negative minimal value). In such a case, this function returns 0.

Panics

This function will panic if rhs is 0.

Examples

Basic usage:

assert_eq!(100i8.wrapping_rem(10), 0);
assert_eq!((-128i8).wrapping_rem(-1), 0);Run

`pub fn wrapping_neg(self) -> i16`
1.2.0
[src]

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one negates MIN on a signed type (where MIN is the negative minimal value for the type); this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Examples

Basic usage:

assert_eq!(100i8.wrapping_neg(), -100);
assert_eq!((-128i8).wrapping_neg(), -128);Run

`pub fn wrapping_shl(self, rhs: u32) -> i16`
1.2.0
[src]

Panic-free bitwise shift-left; yields self << mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. The primitive integer types all implement a rotate_left function, which may be what you want instead.

Examples

Basic usage:

assert_eq!((-1i8).wrapping_shl(7), -128);
assert_eq!((-1i8).wrapping_shl(8), -1);Run

`pub fn wrapping_shr(self, rhs: u32) -> i16`
1.2.0
[src]

Panic-free bitwise shift-right; yields self >> mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. The primitive integer types all implement a rotate_right function, which may be what you want instead.

Examples

Basic usage:

assert_eq!((-128i8).wrapping_shr(7), -1);
assert_eq!((-128i8).wrapping_shr(8), -128);Run

`pub fn wrapping_abs(self) -> i16`
1.13.0
[src]

Wrapping (modular) absolute value. Computes self.abs(), wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one takes the absolute value of the negative minimal value for the type this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Examples

Basic usage:

assert_eq!(100i8.wrapping_abs(), 100);
assert_eq!((-100i8).wrapping_abs(), 100);
assert_eq!((-128i8).wrapping_abs(), -128);
assert_eq!((-128i8).wrapping_abs() as u8, 128);Run

`pub fn overflowing_add(self, rhs: i16) -> (i16, bool)`
1.7.0
[src]

Calculates self + rhs

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage

use std::i32;

assert_eq!(5i32.overflowing_add(2), (7, false));
assert_eq!(i32::MAX.overflowing_add(1), (i32::MIN, true));Run

`pub fn overflowing_sub(self, rhs: i16) -> (i16, bool)`
1.7.0
[src]

Calculates self - rhs

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage

use std::i32;

assert_eq!(5i32.overflowing_sub(2), (3, false));
assert_eq!(i32::MIN.overflowing_sub(1), (i32::MAX, true));Run

`pub fn overflowing_mul(self, rhs: i16) -> (i16, bool)`
1.7.0
[src]

Calculates the multiplication of self and rhs.

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage

assert_eq!(5i32.overflowing_mul(2), (10, false));
assert_eq!(1_000_000_000i32.overflowing_mul(10), (1410065408, true));Run

`pub fn overflowing_div(self, rhs: i16) -> (i16, bool)`
1.7.0
[src]

Calculates the divisor when self is divided by rhs.

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

Panics

This function will panic if rhs is 0.

Examples

Basic usage

use std::i32;

assert_eq!(5i32.overflowing_div(2), (2, false));
assert_eq!(i32::MIN.overflowing_div(-1), (i32::MIN, true));Run

`pub fn overflowing_rem(self, rhs: i16) -> (i16, bool)`
1.7.0
[src]

Calculates the remainder when self is divided by rhs.

Returns a tuple of the remainder after dividing along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then 0 is returned.

Panics

This function will panic if rhs is 0.

Examples

Basic usage

use std::i32;

assert_eq!(5i32.overflowing_rem(2), (1, false));
assert_eq!(i32::MIN.overflowing_rem(-1), (0, true));Run

`pub fn overflowing_neg(self) -> (i16, bool)`
1.7.0
[src]

Negates self, overflowing if this is equal to the minimum value.

Returns a tuple of the negated version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g. i32::MIN for values of type i32), then the minimum value will be returned again and true will be returned for an overflow happening.

Examples

Basic usage

use std::i32;

assert_eq!(2i32.overflowing_neg(), (-2, false));
assert_eq!(i32::MIN.overflowing_neg(), (i32::MIN, true));Run

`pub fn overflowing_shl(self, rhs: u32) -> (i16, bool)`
1.7.0
[src]

Shifts self left by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage

assert_eq!(0x10i32.overflowing_shl(4), (0x100, false));
assert_eq!(0x10i32.overflowing_shl(36), (0x100, true));Run

`pub fn overflowing_shr(self, rhs: u32) -> (i16, bool)`
1.7.0
[src]

Shifts self right by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage

assert_eq!(0x10i32.overflowing_shr(4), (0x1, false));
assert_eq!(0x10i32.overflowing_shr(36), (0x1, true));Run

`pub fn overflowing_abs(self) -> (i16, bool)`
1.13.0
[src]

Computes the absolute value of self.

Returns a tuple of the absolute version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g. i32::MIN for values of type i32), then the minimum value will be returned again and true will be returned for an overflow happening.

Examples

Basic usage:

assert_eq!(10i8.overflowing_abs(), (10,false));
assert_eq!((-10i8).overflowing_abs(), (10,false));
assert_eq!((-128i8).overflowing_abs(), (-128,true));Run

`pub fn pow(self, exp: u32) -> i16`
[src]

Raises self to the power of exp, using exponentiation by squaring.

Examples

Basic usage:

let x: i32 = 2; // or any other integer type

assert_eq!(x.pow(4), 16);Run

`pub fn abs(self) -> i16`
[src]

Computes the absolute value of self.

Overflow behavior

The absolute value of i32::min_value() cannot be represented as an i32, and attempting to calculate it will cause an overflow. This means that code in debug mode will trigger a panic on this case and optimized code will return i32::min_value() without a panic.

Examples

Basic usage:

assert_eq!(10i8.abs(), 10);
assert_eq!((-10i8).abs(), 10);Run

`pub fn signum(self) -> i16`
[src]

Returns a number representing sign of self.

0 if the number is zero
1 if the number is positive
-1 if the number is negative

Examples

Basic usage:

assert_eq!(10i8.signum(), 1);
assert_eq!(0i8.signum(), 0);
assert_eq!((-10i8).signum(), -1);Run

`pub fn is_positive(self) -> bool`
[src]

Returns true if self is positive and false if the number is zero or negative.

Examples

Basic usage:

assert!(10i8.is_positive());
assert!(!(-10i8).is_positive());Run

`pub fn is_negative(self) -> bool`
[src]

Returns true if self is negative and false if the number is zero or positive.

Examples

Basic usage:

assert!((-10i8).is_negative());
assert!(!10i8.is_negative());Run

Trait Implementations

`impl Binary for i16`
[src]

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

Formats the value using the given formatter.

`impl FromStr for i16`
[src]

`type Err = ParseIntError`

The associated error which can be returned from parsing.

`fn from_str(src: &str) -> Result<i16, ParseIntError>`
[src]

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

`impl<'a, 'b> Sub<&'a i16> for &'b i16`
[src]

`type Output = <i16 as Sub<i16>>::Output`

The resulting type after applying the - operator.

`fn sub(self, other: &'a i16) -> <i16 as Sub<i16>>::Output`
[src]

Performs the - operation.

`impl<'a> Sub<i16> for &'a i16`
[src]

`type Output = <i16 as Sub<i16>>::Output`

The resulting type after applying the - operator.

`fn sub(self, other: i16) -> <i16 as Sub<i16>>::Output`
[src]

Performs the - operation.

`impl Sub<i16> for i16`
[src]

`type Output = i16`

The resulting type after applying the - operator.

`fn sub(self, other: i16) -> i16`
[src]

Performs the - operation.

`impl<'a> Sub<&'a i16> for i16`
[src]

`type Output = <i16 as Sub<i16>>::Output`

The resulting type after applying the - operator.

`fn sub(self, other: &'a i16) -> <i16 as Sub<i16>>::Output`
[src]

Performs the - operation.

`impl Debug for i16`
[src]