Skip to main content

Spec

Struct Spec 

Source
pub struct Spec {
    pub image: Image,
    pub env: Vec<(String, String)>,
    pub remote_env: Vec<(String, String)>,
    pub on_create: Vec<Cmd>,
    pub ignored: Vec<String>,
    pub file: Option<&'static str>,
}
Expand description

How to make and use one workspace’s container.

Fields§

§image: Image§env: Vec<(String, String)>

Set on the container (containerEnv).

§remote_env: Vec<(String, String)>

Set for each command (remoteEnv).

§on_create: Vec<Cmd>

Run once after creation, in order.

§ignored: Vec<String>

devcontainer.json keys byob doesn’t support.

§file: Option<&'static str>

The devcontainer.json it came from (workspace-relative), if any.

Implementations§

Source§

impl Spec

Source

pub fn default_image(image: &str) -> Self

The default container: image, nothing else.

Source

pub fn for_workspace(ws: &Path, default_image: &str) -> Result<Self, String>

For workspace ws: its devcontainer.json if it has one, else default_image.

Source

pub fn parse(text: &str, base: &Path, ws: &Path) -> Result<Self, String>

Parse devcontainer.json text; relative paths are against base (its folder).

Source

pub fn describe(&self, ws: &Path) -> String

The image name for messages (“python:3-slim”, “built from .devcontainer/Dockerfile”).

Trait Implementations§

Source§

impl Clone for Spec

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 Spec

Source§

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

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

impl Eq for Spec

Source§

impl PartialEq for Spec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Spec

Auto Trait Implementations§

§

impl Forget for Spec

§

impl Freeze for Spec

§

impl Move for Spec

§

impl RefUnwindSafe for Spec

§

impl Send for Spec

§

impl Sync for Spec

§

impl Unpin for Spec

§

impl UnsafeUnpin for Spec

§

impl UnwindSafe for Spec

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.