[−][src]Struct moore_vhdl::ty2::IntegerBasetype

pub struct IntegerBasetype { /* fields omitted */ }

An integer base type.

Implementations

`impl IntegerBasetype`[src]

`pub fn new(range: Range<BigInt>) -> IntegerBasetype`[src]

Create a new integer type.

Example

use moore_vhdl::ty2::{Type, IntegerBasetype, Range, RangeDir};
use num::BigInt;

let a = IntegerBasetype::new(Range::ascending(0, 42));
let b = IntegerBasetype::new(Range::descending(42, 0));

assert_eq!(format!("{}", a), "0 to 42");
assert_eq!(format!("{}", b), "42 downto 0");
assert_eq!(a.dir(), RangeDir::To);
assert_eq!(b.dir(), RangeDir::Downto);
assert_eq!(a.len(), BigInt::from(43));
assert_eq!(b.len(), BigInt::from(43));

Methods from Deref<Target = Range<BigInt>>

`pub fn dir(&self) -> RangeDir`[src]

Return the direction of the range.

Example

use moore_vhdl::ty2::{IntegerRange, RangeDir};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.dir(), RangeDir::To);
assert_eq!(b.dir(), RangeDir::Downto);

`pub fn left(&self) -> &T`[src]

Return the left bound of the range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.left(), &BigInt::from(0));
assert_eq!(b.left(), &BigInt::from(42));

`pub fn right(&self) -> &T`[src]

Return the right bound of the range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.right(), &BigInt::from(42));
assert_eq!(b.right(), &BigInt::from(0));

`pub fn lower(&self) -> &T`[src]

Return the lower bound of the range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.lower(), &BigInt::from(0));
assert_eq!(b.lower(), &BigInt::from(0));

`pub fn upper(&self) -> &T`[src]

Return the upper bound of the range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.upper(), &BigInt::from(42));
assert_eq!(b.upper(), &BigInt::from(42));

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

Return true if the range is a null range.

A null range has its lower bound greater than or equal to its upper bound, and thus also a length of 0 or lower.

Example

use moore_vhdl::ty2::IntegerRange;

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::ascending(42, 0);

assert_eq!(a.is_null(), false);
assert_eq!(b.is_null(), true);

`pub fn len(&self) -> T`[src]

Return the length of the range.

The length of a range is defined as upper + 1 - lower. The result may be negative, indicating that the range is a null range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::ascending(42, 0);

assert_eq!(a.len(), BigInt::from(43));
assert_eq!(b.len(), BigInt::from(-41));

`pub fn has_subrange(&self, subrange: &Self) -> bool`[src]

Check if another range is a subrange of this range.

This function checks if self.lower() is less than or equal to, and self.upper() is larger than or equal to, the corresponding bounds of the subrange.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::ascending(4, 16);
let c = IntegerRange::descending(16, 4);

assert_eq!(a.has_subrange(&b), true);
assert_eq!(a.has_subrange(&c), true);
assert_eq!(b.has_subrange(&a), false);
assert_eq!(c.has_subrange(&a), false);
assert_eq!(b.has_subrange(&c), true);
assert_eq!(c.has_subrange(&b), true);