Skip to main content

MemSource

Struct MemSource 

Source
pub struct MemSource { /* private fields */ }
Expand description

A plugin package held entirely in memory.

Keys are /-separated paths relative to the plugin root; directories exist implicitly wherever a key has a parent. There are no symlinks, so every path is truthfully confined.

use agent_plugins::MemSource;

let plugin = MemSource::new()
    .file("plugin.json", br#"{
        "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
        "name": "in-memory"
    }"#)
    .load()
    .unwrap();
assert_eq!(plugin.manifest.name.as_str(), "in-memory");

Implementations§

Source§

impl MemSource

Source

pub fn new() -> Self

An empty package (which, containing no manifest, would be rejected).

Source

pub fn file(self, path: impl Into<String>, bytes: impl Into<Vec<u8>>) -> Self

Add a file at a /-separated path relative to the plugin root.

Source

pub fn load(self) -> Result<LoadedPlugin, Rejection>

Load the package.

Trait Implementations§

Source§

impl Clone for MemSource

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MemSource

Source§

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

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

impl Default for MemSource

Source§

fn default() -> Self

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

impl Source for MemSource

Source§

type Error = !

The source’s own failure type. Failures are folded into the loading conversation as Answer::Unavailable, where the spec’s failure boundaries decide how far the damage spreads.
Source§

fn kind(&mut self, path: &PackagePath) -> Result<Option<FileKind>, Infallible>

What kind of entry does path resolve to? None if absent.
Source§

fn confined(&mut self, _path: &PackagePath) -> Result<bool, Infallible>

Does path, fully resolved, stay within the plugin root? Sources that cannot contain links may simply return Ok(true).
Source§

fn read(&mut self, path: &PackagePath) -> Result<Vec<u8>, Infallible>

Read the file at path.
Source§

fn list(&mut self, path: &PackagePath) -> Result<Vec<DirEntry>, Infallible>

List the immediate entries of the directory at path.

Auto Trait Implementations§

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.

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.