Struct Client

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

Client for Guides

Client for invoking operations on Guides. Each operation on Guides is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = stedi_sdk_config::load_from_env().await;
    let client = stedi_sdk_client_guides::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use stedi_sdk_config::retry::RetryConfig;
let shared_config = stedi_sdk_config::load_from_env().await;
let config = stedi_sdk_client_guides::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = stedi_sdk_client_guides::Client::from_conf(config);

Implementations§

Source§

impl Client

Source

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config, ) -> Self

Creates a client with the given service configuration.

Source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

pub fn change_guide_visibility(&self) -> ChangeGuideVisibility

Constructs a fluent builder for the ChangeGuideVisibility operation.

Source

pub fn create_guide(&self) -> CreateGuide

Constructs a fluent builder for the CreateGuide operation.

Source

pub fn create_guide_attachment(&self) -> CreateGuideAttachment

Constructs a fluent builder for the CreateGuideAttachment operation.

Source

pub fn create_guide_sample(&self) -> CreateGuideSample

Constructs a fluent builder for the CreateGuideSample operation.

Source

pub fn delete_guide(&self) -> DeleteGuide

Constructs a fluent builder for the DeleteGuide operation.

Source

pub fn delete_guide_attachment(&self) -> DeleteGuideAttachment

Constructs a fluent builder for the DeleteGuideAttachment operation.

Source

pub fn delete_guide_sample(&self) -> DeleteGuideSample

Constructs a fluent builder for the DeleteGuideSample operation.

Source

pub fn get_account_config(&self) -> GetAccountConfig

Constructs a fluent builder for the GetAccountConfig operation.

Source

pub fn get_guide(&self) -> GetGuide

Constructs a fluent builder for the GetGuide operation.

Source

pub fn get_guides_network(&self) -> GetGuidesNetwork

Constructs a fluent builder for the GetGuidesNetwork operation.

Source

pub fn get_public_account_config(&self) -> GetPublicAccountConfig

Constructs a fluent builder for the GetPublicAccountConfig operation.

Source

pub fn get_public_guide(&self) -> GetPublicGuide

Constructs a fluent builder for the GetPublicGuide operation.

Source

pub fn get_public_shared_guide(&self) -> GetPublicSharedGuide

Constructs a fluent builder for the GetPublicSharedGuide operation.

Source

pub fn get_x12_transaction_set_metadata(&self) -> GetX12TransactionSetMetadata

Constructs a fluent builder for the GetX12TransactionSetMetadata operation.

Source

pub fn list_all_public_guides(&self) -> ListAllPublicGuides

Constructs a fluent builder for the ListAllPublicGuides operation. This operation supports pagination; See into_paginator().

Source

pub fn list_guide_attachments(&self) -> ListGuideAttachments

Constructs a fluent builder for the ListGuideAttachments operation.

Source

pub fn list_guides(&self) -> ListGuides

Constructs a fluent builder for the ListGuides operation. This operation supports pagination; See into_paginator().

Source

pub fn list_guide_samples(&self) -> ListGuideSamples

Constructs a fluent builder for the ListGuideSamples operation.

Source

pub fn list_public_guide_attachments(&self) -> ListPublicGuideAttachments

Constructs a fluent builder for the ListPublicGuideAttachments operation.

Source

pub fn list_public_guides(&self) -> ListPublicGuides

Constructs a fluent builder for the ListPublicGuides operation. This operation supports pagination; See into_paginator().

Source

pub fn list_public_guide_samples(&self) -> ListPublicGuideSamples

Constructs a fluent builder for the ListPublicGuideSamples operation.

Source

pub fn list_public_shared_guide_attachments( &self, ) -> ListPublicSharedGuideAttachments

Constructs a fluent builder for the ListPublicSharedGuideAttachments operation.

Source

pub fn list_public_shared_guide_samples(&self) -> ListPublicSharedGuideSamples

Constructs a fluent builder for the ListPublicSharedGuideSamples operation.

Source

pub fn list_x12_transaction_sets(&self) -> ListX12TransactionSets

Constructs a fluent builder for the ListX12TransactionSets operation.

Source

pub fn publish_guide(&self) -> PublishGuide

Constructs a fluent builder for the PublishGuide operation.

Source

pub fn revert_guide(&self) -> RevertGuide

Constructs a fluent builder for the RevertGuide operation.

Source

pub fn update_account_config(&self) -> UpdateAccountConfig

Constructs a fluent builder for the UpdateAccountConfig operation.

Source

pub fn update_guide(&self) -> UpdateGuide

Constructs a fluent builder for the UpdateGuide operation.

Source

pub fn update_guide_attachment(&self) -> UpdateGuideAttachment

Constructs a fluent builder for the UpdateGuideAttachment operation.

Source

pub fn update_guide_sample(&self) -> UpdateGuideSample

Constructs a fluent builder for the UpdateGuideSample operation.

Source

pub fn update_share_config(&self) -> UpdateShareConfig

Constructs a fluent builder for the UpdateShareConfig operation.

Source§

impl Client

Source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics
  • This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

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 Client

Source§

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

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

impl From<Client> for Client

Source§

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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

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