Struct BlockHeight 

pub struct BlockHeight { /* private fields */ }

BlockHeight is the height of a block, measured as the number of blocks since the genesis of the chain. The first block of transactions is at height 0. It is signed to prevent overflows in calculations.

Implementations

impl BlockHeight

pub fn into_inner(self) -> i64

pub const fn new(_inner: i64) -> BlockHeight

impl BlockHeight

pub fn checked_add(&self, blocks: i64) -> Option<BlockHeight>

self + blocks, or None on overflow.

pub fn checked_sub(&self, blocks: i64) -> Option<BlockHeight>

self - blocks, or None on overflow.

pub fn blocks_since(&self, earlier: &BlockHeight) -> i64

The blocks from earlier to self: negative if earlier is in fact later.

The same as self - earlier. Panics if the difference overflows i64; see checked_blocks_since.

pub fn checked_blocks_since(&self, earlier: &BlockHeight) -> Option<i64>

The blocks from earlier to self, or None if the difference overflows i64.

Trait Implementations

impl Add<i64> for &BlockHeight

type Output = BlockHeight

The resulting type after applying the + operator.

fn add(self, rhs: i64) -> BlockHeight

Performs the + operation.

impl Add<i64> for BlockHeight

type Output = BlockHeight

The resulting type after applying the + operator.

fn add(self, rhs: i64) -> BlockHeight

Performs the + operation.

impl AddAssign<i64> for BlockHeight

fn add_assign(&mut self, rhs: i64)

Performs the += operation.

impl Clone for BlockHeight

fn clone(&self) -> BlockHeight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CollectAuthHandles for BlockHeight

fn collect_auth_handles( &self, _out: &mut AuthHandleBuf, ) -> Result<(), FaultString>

impl ConstMaxSize for BlockHeight

const MAX_SIZE: Option<usize>

Worst-case CXS encoded size in bytes, or None if unbounded.

impl ConstMaxSize for BlockHeight

const MAX_SIZE: Option<usize>

Worst-case TXS encoded size in bytes, or None if unbounded.

impl ContractTypeRefSpec for BlockHeight

const INFO: ContractTypeInfo<'static>

The type reference. Transitive type definitions are not carried here; they are retained via the linker-anchor mechanism (__THRUPUT_SPEC_ANCHOR_ROOT) and resolved by spec-tool.

const SIGNED_PREIMAGE: Option<&'static ContractTypeView<'static>> = _

How this type appears as a signed-token preimage (ContractTypeView::SignedToken’s payload): the type itself by default, or None for a type-erased payload (the SDK’s Opaque overrides this).

impl Debug for BlockHeight

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

Formats the value using the given formatter.

impl Deref for BlockHeight

type Target = i64

The resulting type after dereferencing.

fn deref(&self) -> &<BlockHeight as Deref>::Target

Dereferences the value.

impl DerefMut for BlockHeight

fn deref_mut(&mut self) -> &mut <BlockHeight as Deref>::Target

Mutably dereferences the value.

impl EncodesAs<BlockHeight> for BlockHeight

impl Eq for BlockHeight

impl From<i64> for BlockHeight

fn from(_inner: i64) -> BlockHeight

Converts to this type from the input type.

impl Hash for BlockHeight

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for BlockHeight

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Mintable for BlockHeight

fn mint_into_parent(preimage: BlockHeight, _children: &mut ChildNodeBuf) -> Self

impl MintableType for BlockHeight

type Preimage = BlockHeight

impl Ord for BlockHeight

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for BlockHeight

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BlockHeight

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'_r> ReadXDR<'_r> for BlockHeight

fn read_xdr<R>(r: &mut R) -> Result<BlockHeight, ReadError>

where R: Reader<'_r>,

Reads an XDR value from the reader.

fn read_xdr_in_place<R, '__xdrs_s>( r: &mut R, __xdrs_slot: Slot<'__xdrs_s, BlockHeight>, ) -> Result<Init<'__xdrs_s, BlockHeight>, ReadError>

where R: Reader<'_r>,

Reads an XDR value directly into slot, without first building it on the stack.

impl ReceiveAuthHandles for BlockHeight

fn receive_auth_handles( &mut self, _handles: &mut impl Iterator<Item = u32>, ) -> Result<(), AuthTokenError>

impl StructuralPartialEq for BlockHeight

impl Sub for BlockHeight

type Output = i64

The resulting type after applying the - operator.

fn sub(self, rhs: BlockHeight) -> i64

Performs the - operation.

impl Sub<&BlockHeight> for &BlockHeight

type Output = i64

The resulting type after applying the - operator.

fn sub(self, rhs: &BlockHeight) -> i64

Performs the - operation.

impl Sub<&BlockHeight> for BlockHeight

type Output = i64

The resulting type after applying the - operator.

fn sub(self, rhs: &BlockHeight) -> i64

Performs the - operation.

impl Sub<BlockHeight> for &BlockHeight

type Output = i64

The resulting type after applying the - operator.

fn sub(self, rhs: BlockHeight) -> i64

Performs the - operation.

impl Sub<i64> for &BlockHeight

type Output = BlockHeight

The resulting type after applying the - operator.

fn sub(self, rhs: i64) -> BlockHeight

Performs the - operation.

impl Sub<i64> for BlockHeight

type Output = BlockHeight

The resulting type after applying the - operator.

fn sub(self, rhs: i64) -> BlockHeight

Performs the - operation.

impl SubAssign<i64> for BlockHeight

fn sub_assign(&mut self, rhs: i64)

Performs the -= operation.

impl WriteXDR for BlockHeight

fn write_xdr<F, W>(&self, w: &mut W) -> Result<(), WriteError>

where W: Writer<F>,

Writes this value as XDR data to the writer.

unsafe fn write_xdr_unchecked<F, W>(&self, w: &mut W)

where W: WriterUnchecked<F>,

Writes this value as XDR data to the writer, without runtime checks.