Skip to main content

IcpBuildEnvironment

Enum IcpBuildEnvironment 

Source
pub enum IcpBuildEnvironment {
    Ic,
    Local,
}
Expand description

IcpBuildEnvironment

Build-time network class baked into Canic Wasm artifacts.

Variants§

§

Ic

§

Local

Implementations§

Source§

impl IcpBuildEnvironment

Source

pub const fn as_str(self) -> &'static str

Examples found in repository?
examples/build_artifact.rs (line 51)
8fn main() -> Result<(), Box<dyn std::error::Error>> {
9    let mut args = std::env::args().skip(1);
10    let (
11        Some(canister_name),
12        Some(profile),
13        Some(workspace_root),
14        Some(icp_root),
15        Some(config_path),
16    ) = (
17        args.next(),
18        args.next(),
19        args.next(),
20        args.next(),
21        args.next(),
22    )
23    else {
24        return Err(
25            "usage: cargo run -p canic-host --example build_artifact -- <canister-name> <debug|fast|release> <workspace-root> <icp-root> <config-path> [--refresh-wasm-store-did]"
26                .into(),
27        );
28    };
29    let refresh_canonical_wasm_store_did = match args.next().as_deref() {
30        None => false,
31        Some("--refresh-wasm-store-did") if canister_name == "wasm_store" => true,
32        Some("--refresh-wasm-store-did") => {
33            return Err("--refresh-wasm-store-did requires canister-name wasm_store".into());
34        }
35        Some(_) => return Err("unknown build_artifact argument".into()),
36    };
37    if args.next().is_some() {
38        return Err("build_artifact accepts at most six arguments".into());
39    }
40    let profile = profile.parse::<CanisterBuildProfile>()?;
41
42    let workspace_root = PathBuf::from(workspace_root).canonicalize()?;
43    let icp_root = PathBuf::from(icp_root).canonicalize()?;
44    let config_path = resolve_path(&workspace_root, &config_path).canonicalize()?;
45    let environment = std::env::var("ICP_ENVIRONMENT").unwrap_or_else(|_| "local".to_string());
46    let build_network = resolve_icp_build_environment_from_root(&icp_root, &environment)?;
47    let context = WorkspaceBuildContext {
48        role: canister_name.clone(),
49        profile,
50        environment,
51        build_network: build_network.as_str().to_string(),
52        config_path,
53        workspace_root,
54        icp_root,
55        local_replica: None,
56        refresh_canonical_wasm_store_did,
57    };
58    print_workspace_build_context_once(&context)?;
59    let output = build_workspace_canister_artifact(&context)?;
60    copy_icp_wasm_output(&canister_name, &output)?;
61    println!("{}", output.wasm_gz_path.display());
62    Ok(())
63}

Trait Implementations§

Source§

impl Clone for IcpBuildEnvironment

Source§

fn clone(&self) -> IcpBuildEnvironment

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 Copy for IcpBuildEnvironment

Source§

impl Debug for IcpBuildEnvironment

Source§

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

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

impl Eq for IcpBuildEnvironment

Source§

impl PartialEq for IcpBuildEnvironment

Source§

fn eq(&self, other: &IcpBuildEnvironment) -> 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 IcpBuildEnvironment

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more