Struct Collection 

pub struct Collection {
    pub name: Option<String>,
    pub requests: Vec<Request>,
}

A named group of requests living in one YAML file.

name: Example API        # optional, a label for the collection as a whole
requests:
  - name: List users     # required inside a collection: it is the selector
    method: GET
    url: https://api.example.com/users
  - name: Create user
    method: POST
    url: https://api.example.com/users
    body: '{"name": "ada"}'

requests is a list, not a map of name-to-request, for two reasons. First, each entry is then exactly a single-request file: a request can be lifted into a collection (or pulled back out into its own file) verbatim, with its name staying a field instead of becoming a key. There is one request shape in Sendra, not two. Second, a list preserves file order, which is the order sendra run <file> sends them in; the map types serde reaches for either sort the entries (BTreeMap) or need a dependency (IndexMap) to avoid it. Lookup by name is then a linear scan, which costs nothing at the sizes a hand-written collection reaches.

Fields

name: Option<String>

requests: Vec<Request>

Implementations

impl Collection

pub fn get(&self, name: &str) -> Result<&Request, SendraError>

Look a request up by its name.

Errors with SendraError::RequestNotFound, which carries the names that do exist, rather than returning a bare Option — a missing name is a user-facing mistake worth a good message everywhere it happens.

pub fn names(&self) -> Vec<String>

The name of every request, in file order.

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Collection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Collection

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Collection

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Collection