Skip to main content

GetLinksInputBuilder

Struct GetLinksInputBuilder 

Source
pub struct GetLinksInputBuilder(/* private fields */);
Expand description

A builder to streamline creating a GetLinksInput.

Example: Get links of any time from a given base address.

use hdk::prelude::*;

    let my_base = ActionHash::from_raw_36(vec![0; 36]); // Some base address, this is a dummy address created for the example!
    let links = get_links(LinkQuery::try_new(my_base, ..)?, GetStrategy::default())?;

Example: Get links of a specific type from a given base address.

use hdk::prelude::*;

#[hdk_link_types]
pub enum LinkTypes {
    Example,
}

    let my_base = ActionHash::from_raw_36(vec![0; 36]); // Some base address, this is a dummy address created for the example!
    let links = get_links(LinkQuery::try_new(my_base, LinkTypes::Example)?, GetStrategy::default())?;

You can add additional filters using the functions defined on the builder. For example, to only fetch links that are available locally, without going to the network:

use hdk::prelude::*;

    let my_base = ActionHash::from_raw_36(vec![0; 36]); // Some base address, this is a dummy address created for the example!
    let links = get_links(LinkQuery::try_new(my_base, ..)?, GetStrategy::Local)?;

Implementations§

Source§

impl GetLinksInputBuilder

Source

pub fn try_new( base_address: impl Into<AnyLinkableHash>, link_type: impl LinkTypeFilterExt, ) -> Result<Self, WasmError>

Create a new GetLinksInputBuilder from the required fields for a GetLinksInput.

Source

pub fn get_options(self, get_strategy: GetStrategy) -> Self

Fetch links from network or local only.

Source

pub fn tag_prefix(self, tag_prefix: LinkTag) -> Self

Filter for links with the given tag prefix.

Source

pub fn before(self, before: Timestamp) -> Self

Filter for links created before before.

Source

pub fn after(self, after: Timestamp) -> Self

Filter for links create after after.

Source

pub fn author(self, author: AgentPubKey) -> Self

Filter for links created by this author.

Source

pub fn build(self) -> GetLinksInput

Construct the result of the builder.

Trait Implementations§

Source§

impl Clone for GetLinksInputBuilder

Source§

fn clone(&self) -> GetLinksInputBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GetLinksInputBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for GetLinksInputBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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.
Source§

impl StructuralPartialEq for GetLinksInputBuilder

Auto Trait Implementations§

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> 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> Same for T

Source§

type Output = T

Should always be Self
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, 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<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