Skip to main content

Block

avail_rust_client::block

Struct Block 

Source 
pub struct Block { /* private fields */ }
Expand description

High-level handle bound to a specific block id (height or hash).

Implementations§

Source§

impl Block

Source

pub fn new(client: Client, block_id: impl Into<HashStringNumber>) -> Self

Constructs a view over the block identified by block_id.

§Parameters
  • client: RPC client used for follow-up queries.
  • block_id: Block number, hash, or string convertible into HashStringNumber.
§Returns
  • Self: Block helper bound to the supplied identifier.
Source

pub fn encoded(&self) -> BlockEncodedExtrinsicsQuery

Returns a helper for retrieving encoded extrinsic payloads in this block.

§Returns
  • EncodedExtrinsics: View over encoded extrinsic payloads and metadata.
Source

pub fn extrinsics(&self) -> BlockExtrinsicsQuery

Returns a helper for decoding extrinsics contained in this block.

§Returns
  • Extrinsics: View that decodes raw extrinsics into runtime calls.
Source

pub async fn extrinsic_infos( &self, opts: ExtrinsicOpts, ) -> Result<Vec<ExtrinsicInfo>, Error>

Fetches raw extrinsic metadata using the supplied filters.

§Arguments
  • opts - Filters controlling which extrinsics are returned and how they are encoded.
§Returns

Returns the list of matching extrinsic metadata entries.

Source

pub fn events(&self) -> BlockEventsQuery

Returns an event helper scoped to this block.

§Returns
  • Events: View that fetches events emitted by the block.
Source

pub fn set_retry_on_error(&mut self, value: Option<bool>)

Overrides the retry behaviour for future RPC calls made through this helper.

§Parameters
  • value: Some(true) to force retries, Some(false) to disable retries, None to inherit the client default.
§Returns
  • (): The override is stored for subsequent operations.
§Side Effects
  • Updates the internal retry setting used by follow-up RPC calls.
Source

pub async fn justification(&self) -> Result<Option<GrandpaJustification>, Error>

Fetches the GRANDPA justification associated with this block, if any.

§Returns
  • Ok(Some(GrandpaJustification)): The runtime provided a justification.
  • Ok(None): No justification exists for the requested block.
  • Err(Error): Resolving the block identifier or performing the RPC call failed.
§Side Effects
  • Performs RPC calls to resolve the block and download the justification.
Source

pub fn should_retry_on_error(&self) -> bool

Reports whether this helper retries RPC failures.

§Returns
  • true: Retries are enabled either explicitly or via the client default.
  • false: Retries are disabled.
Source

pub async fn timestamp(&self) -> Result<u64, Error>

Retrieves the UNIX timestamp stored in this block’s runtime timestamp.set extrinsic.

§Returns
  • Ok(u64): Timestamp provided by the block’s timestamp extrinsic.
  • Err(Error): The timestamp extrinsic was missing or the RPC lookup failed.
§Side Effects
  • Fetches extrinsic data over RPC, honouring the retry configuration.
Source

pub async fn info(&self) -> Result<BlockInfo, Error>

Fetches high-level metadata (number, hash, parent) for this block.

§Returns
  • Ok(BlockInfo): Metadata describing the block.
  • Err(Error): Resolving the block identifier or making the RPC call failed.
§Side Effects
  • Performs an RPC call and may retry according to the retry policy.
Source

pub async fn header(&self) -> Result<AvailHeader, Error>

Fetches the header associated with this block.

§Returns
  • Ok(AvailHeader): Header returned by the node.
  • Err(Error): Resolving the block identifier or performing the RPC call failed.
§Side Effects
  • Performs an RPC call and may retry according to the retry policy.
Source

pub async fn author(&self) -> Result<AccountId, Error>

Fetches the author recorded for this block.

§Returns
  • Ok(AccountId): Account identifier attributed as the block author.
  • Err(Error): Resolving the block identifier or performing the RPC call failed.
§Side Effects
  • Performs an RPC call and may retry according to the retry policy.
Source

pub async fn extrinsic_count(&self) -> Result<usize, Error>

Counts how many extrinsics the block contains.

§Returns
  • Ok(u32): Number of extrinsics recorded in the block.
  • Err(Error): Enumerating the extrinsics failed.
§Side Effects
  • Fetches extrinsic metadata over RPC, honouring the retry configuration.
Source

pub async fn event_count(&self) -> Result<usize, Error>

Counts how many events were emitted in this block.

§Returns
  • Ok(u32): Number of events exposed by the node.
  • Err(Error): The RPC request failed.
§Side Effects
  • Performs an RPC call and may retry according to the retry policy.
Source

pub async fn weight(&self) -> Result<PerDispatchClassWeight, Error>

Retrieves the dispatch-class weight totals reported for this block.

§Returns
  • Ok(PerDispatchClassWeight): Weight data grouped by dispatch class.
  • Err(Error): Fetching the weight via RPC failed.
§Side Effects
  • Performs an RPC call and may retry according to the retry policy.
Source

pub async fn extrinsic_weight(&self) -> Result<Weight, Error>

Aggregates the weight consumed by extrinsics, based on success and failure events.

§Returns
  • Ok(Weight): Sum of weights observed in extrinsic success or failure events.
  • Err(Error): Fetching or decoding the event data failed.
§Side Effects
  • Fetches block events over RPC, honouring the retry configuration.

Trait Implementations§

Source§

impl Clone for Block

Source§

fn clone(&self) -> Block

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

Auto Trait Implementations§

§

impl !RefUnwindSafe for Block

§

impl !UnwindSafe for Block

§

impl Freeze for Block

§

impl Send for Block

§

impl Sync for Block

§

impl Unpin for Block

§

impl UnsafeUnpin for Block

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> JsonSchemaMaybe for T

Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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