Skip to main content

PostageBatch

Struct PostageBatch

pub struct PostageBatch {Show 13 fields
    pub batch_id: BatchId,
    pub amount: Option<BigInt>,
    pub start: u64,
    pub owner: String,
    pub depth: u8,
    pub bucket_depth: u8,
    pub immutable: bool,
    pub batch_ttl: i64,
    pub utilization: u32,
    pub usable: bool,
    pub exists: bool,
    pub label: String,
    pub block_number: u64,
}

Expand description

Postage batch as returned by GET /stamps / GET /stamps/{id} (owner-only view; includes utilization, label, blockNumber).

Wire-format gotcha caught against a live Bee: the per-chunk price is keyed "amount" not "value", and the immutable flag is keyed "immutableFlag" not "immutable". bee-go landed both fixes in v1.0; we get them right by construction here.

Fields§

§batch_id: BatchId

Batch identifier.

§amount: Option<BigInt>

Per-chunk amount (PLUR).

§start: u64

Block number when the batch was bought.

§owner: String

Owner address (hex).

§depth: u8

Batch depth.

§bucket_depth: u8

Bucket depth.

§immutable: bool

Whether the batch is immutable.

§batch_ttl: i64

Estimated TTL in seconds.

§utilization: u32

Bucket utilization stats.

§usable: bool

Whether the batch is currently usable.

§exists: bool

Whether Bee currently knows about the batch.

§label: String

Optional label.

§block_number: u64

Block number reported by Bee.

Trait Implementations§

impl Clone for PostageBatch

fn clone(&self) -> PostageBatch

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for PostageBatch

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for PostageBatch

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for PostageBatch

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

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

1.0.0 (const: unstable) · Source§

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 Eq for PostageBatch

impl StructuralPartialEq for PostageBatch

Auto Trait Implementations§

impl Freeze for PostageBatch

impl RefUnwindSafe for PostageBatch

impl Send for PostageBatch

impl Sync for PostageBatch

impl Unpin for PostageBatch

impl UnsafeUnpin for PostageBatch

impl UnwindSafe for PostageBatch

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,