Struct koibumi_core::message::Object

pub struct Object { /* fields omitted */ }

An "object" message that consists of a object such as a public key or an one-to-one message.

Implementations

impl Object

pub const MAX_OBJECT_PAYLOAD_LENGTH: usize

The maximum length of the payload of a object message.

pub fn new(
    nonce: Nonce,
    header: Header,
    object_payload: Vec<u8>
) -> Result<Self, TooLongError>

Constructs an object message from the specified parameters.

pub fn nonce(&self) -> Nonce

Returns the nonce of the proof of work.

pub fn header(&self) -> &Header

Returns the object header.

pub fn object_payload(&self) -> &[u8]

Returns the payload of the object message.

pub fn inv_hash(&self) -> InvHash

Returns the inventory hash of the object message.

pub fn validate_pow_custom(
    &self,
    config: &Config,
    nonce_trials_per_byte: NonceTrialsPerByte,
    extra_bytes: PayloadLengthExtraBytes,
    now: Time
) -> Result<(), ValidateError>

Validates the proof of work of the object message with the specified custom parameters.

pub fn validate_pow(&self, config: &Config) -> Result<(), ValidateError>

Validates the proof of work of the object message with the default parameters.

Trait Implementations

impl Clone for Object

pub fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Eq for Object

impl Hash for Object

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Message for Object

pub const COMMAND: Command

What type of message this is.

impl PartialEq<Object> for Object

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

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

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

This method tests for !=.

impl SizedReadFrom for Object

pub fn sized_read_from(r: &mut dyn Read, len: usize) -> Result<Self> where
    Self: Sized, 

Reads this object as a Bitmessage entity from a reader with a specified byte length.

impl StructuralEq for Object

impl StructuralPartialEq for Object

impl TryFrom<Object> for Msg

type Error = TryIntoMsgError

The type returned in the event of a conversion error.

pub fn try_from(object: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Object> for Broadcast

type Error = TryIntoBroadcastError

The type returned in the event of a conversion error.

pub fn try_from(object: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl WriteTo for Object

pub fn write_to(&self, w: &mut dyn Write) -> Result<()>

Writes this object as a Bitmessage entity to a writer.