Struct Collection 

pub struct Collection {
    pub name: Option<String>,
    pub profiles: IndexMap<ProfileId, Profile>,
    pub recipes: RecipeTree,
}

A collection of profiles, requests, etc. This is the primary Slumber unit of configuration.

Fields

name: Option<String>

Descriptive name for the collection

profiles: IndexMap<ProfileId, Profile>

Map of profiles, keyed by their unique IDs

recipes: RecipeTree

Map of requests and folders, keyed by their unique IDs. Folders allow for nested maps of more requests and folders. All IDs must be unique throughout the entire tree, not just at their level.

Implementations

impl Collection

pub fn load(path: &Path) -> Result<Self, CollectionError>

Load collection from a file

pub fn parse(input: &str) -> Result<Self, CollectionError>

Load collection from a YAML string

impl Collection

pub fn default_profile(&self) -> Option<&Profile>

Get the profile marked as default: true, if any. At most one profile can be marked as default.

Trait Implementations

impl Debug for Collection

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

Formats the value using the given formatter.

impl Default for Collection

fn default() -> Collection

Returns the “default value” for a type.

impl DeserializeYaml for Collection

fn expected() -> Expected

What kind of YAML value do we expect to see?

fn deserialize(yaml: SourcedYaml<'_>, source_map: &SourceMap) -> Result<Self>

Deserialize the given YAML value into this type

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.