Struct Session

pub struct Session { /* private fields */ }

A handle representing a Scoop session.

Implementations

impl Session

pub fn new() -> Session

Create a new session.

The default config path will be used to locate the config file for the session.

Returns

A new session.

pub fn new_with<P>(config_path: P) -> Result<Session, Error>

where P: AsRef<Path>,

Create a new session with the given config path.

Returns

A new session.

Errors

This method will return an error if the config file is not found or cannot be parsed.

pub fn config(&self) -> Ref<'_, Config>

Get an immutable reference to the config held by the session.

This method is primarily used for doing a fine-grained read to the config aside from reading it as a whole via config_list. Caller of this method may not be able to perform some operations, which will internally alter the config, before the reference is dropped.

pub fn event_bus(&self) -> &EventBus

Get the event bus for the session.

The event bus is used for transmitting events between the session backend and the caller frontend.

Returns

The event bus for the session.

pub fn set_user_agent(&self, user_agent: &str) -> Result<(), Error>

Set the user agent for the session.

User agent is used when performing network related operations such as downloading packages. User agent for a session can only be set once. If not set, the default user agent will be used. The default user agent is Scoop/1.0 (+http://scoop.sh/).

Errors

This method will return an error if the user agent has already been set.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Self

Returns the “default value” for a type.