SclRequest

Struct SclRequest 

Source
pub struct SclRequest<'a, T: SclObject> {
    pub obj_name: Option<String>,
    pub sc_name: Option<String>,
    pub body: Option<&'a T>,
    pub query: &'a [(&'a str, &'a str)],
}
Expand description

A builder to construct a request object that can be used with the SclClient.

All members are optional and can be omitted. Specify them to create more complex requests.

§Examples

use scl_lib::api_objects::VirtualMachine;
use scl_lib::client::SclRequest;

let req = SclRequest::<VirtualMachine>::new()
    .obj_name("vm-01")
    .sc("sc-01")
    .query(&[("node", "node-01")]);

Fields§

§obj_name: Option<String>§sc_name: Option<String>§body: Option<&'a T>§query: &'a [(&'a str, &'a str)]

Implementations§

Source§

impl<'a, T: SclObject> SclRequest<'a, T>

Source

pub fn new() -> Self

Creates and initializes a new SclRequest object.

Source

pub fn obj_name(self, name: &str) -> Self

Sets the name of the request object to use as T::path()/<name> when constructing the URL.

Source

pub fn body(self, obj: &'a T) -> Self

Adds a SclObject as body data to the request object.

Source

pub fn sc(self, sc_name: &str) -> Self

Sets the name of the the separation context to use as /scs/<sc_name> when constructing the URL.

Source

pub fn query(self, query: &'a [(&'a str, &'a str)]) -> Self

Specify query parameters for the request.

Source

pub fn url_path(&self) -> String

Constructs a URL path from all member variables and returns it as String.

Trait Implementations§

Source§

impl<'a, T: Clone + SclObject> Clone for SclRequest<'a, T>

Source§

fn clone(&self) -> SclRequest<'a, T>

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<'a, T: Debug + SclObject> Debug for SclRequest<'a, T>

Source§

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

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

impl<'a, T: Default + SclObject> Default for SclRequest<'a, T>

Source§

fn default() -> SclRequest<'a, T>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for SclRequest<'a, T>

§

impl<'a, T> RefUnwindSafe for SclRequest<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for SclRequest<'a, T>
where T: Sync,

§

impl<'a, T> Sync for SclRequest<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for SclRequest<'a, T>

§

impl<'a, T> UnwindSafe for SclRequest<'a, T>
where T: RefUnwindSafe,

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.

§

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

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