Struct aleph_alpha_client::How

pub struct How {
    pub be_nice: bool,
}

Controls of how to execute a task

Fields

be_nice: bool

Set this to true if you want to not put any load on the API in case it is already pretty busy for the models you intend to use. All this does from the user perspective is that it makes it more likely you get a Busy response from the server. One of the reasons you may want to set is that you are an employee or associate of Aleph Alpha and want to perform experiments without hurting paying customers.

Implementations

impl How

pub fn be_nice(self) -> Self

Returns a new How based on the given one with the How::be_nice flag being set.

Trait Implementations

impl Clone for How

fn clone(&self) -> How

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for How

fn default() -> How

Returns the “default value” for a type.

impl Hash for How

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<How> for How

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for How

impl StructuralEq for How

impl StructuralPartialEq for How