Struct Time

pub struct Time(/* private fields */);

A UNIX timestamp, seconds since epoch, guaranteed to always contain a valid time value.

Note that there is no manipulation of the inner value during construction or when using to_consensus_u32(). Said another way, Time(x) means ‘x seconds since epoch’ not ‘(x - threshold) seconds since epoch’.

Implementations

impl Time

pub fn from_consensus(n: u32) -> Result<Time, Error>

Constructs a new block time.

Errors

If n does not encode a UNIX time stamp (see documentation on LockTime).

Examples

use bitcoin::blockdata::locktime::Time;

let t: u32 = 1653195600; // May 22nd, 5am UTC.
let time = Time::from_consensus(t).expect("invalid time value");
assert_eq!(time.to_consensus_u32(), t);

pub fn to_consensus_u32(self) -> u32

Converts this Time to its inner u32 value.

Examples

use bitcoin::LockTime;

let n_lock_time: u32 = 1653195600; // May 22nd, 5am UTC.
let lock_time = LockTime::from_consensus(n_lock_time);
assert_eq!(lock_time.to_consensus_u32(), n_lock_time);

Trait Implementations

impl Clone for Time

fn clone(&self) -> Time

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Time

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

Formats the value using the given formatter.

impl Display for Time

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

Formats the value using the given formatter.

impl From<Time> for LockTime

fn from(t: Time) -> LockTime

Converts to this type from the input type.

impl FromStr for Time

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Time, <Time as FromStr>::Err>

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

impl Hash for Time

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 Ord for Time

fn cmp(&self, other: &Time) -> 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.

impl PartialEq for Time

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Time

fn partial_cmp(&self, other: &Time) -> 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 TryFrom<&str> for Time

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Time, <Time as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for Time

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Time, <Time as TryFrom<String>>::Error>

Performs the conversion.

impl Copy for Time

impl Eq for Time

impl StructuralPartialEq for Time