Skip to main content

BuildCommandBuilder

Struct BuildCommandBuilder 

Source
pub struct BuildCommandBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> BuildCommandBuilder<S>

Source

pub fn build(self) -> BuildCommand
where S: IsComplete,

Finish building and return the requested object

Source

pub fn recipe( self, value: impl Into<Vec<PathBuf>>, ) -> BuildCommandBuilder<SetRecipe<S>>
where S::Recipe: IsUnset,

Optional (Some / Option setters). The recipe file to build an image

Source

pub fn maybe_recipe( self, value: Option<impl Into<Vec<PathBuf>>>, ) -> BuildCommandBuilder<SetRecipe<S>>
where S::Recipe: IsUnset,

Optional (Some / Option setters). The recipe file to build an image

Source

pub fn push(self, value: bool) -> BuildCommandBuilder<SetPush<S>>
where S::Push: IsUnset,

Optional (Some / Option setters). Default: false.

Push the image with all the tags.

Requires --registry, --username, and --password if not building in CI.

Source

pub fn maybe_push(self, value: Option<bool>) -> BuildCommandBuilder<SetPush<S>>
where S::Push: IsUnset,

Optional (Some / Option setters). Default: false.

Push the image with all the tags.

Requires --registry, --username, and --password if not building in CI.

Source

pub fn platform( self, value: Vec<Platform>, ) -> BuildCommandBuilder<SetPlatform<S>>
where S::Platform: IsUnset,

Optional (Some / Option setters). Default: <Vec<Platform> as Default>::default().

Build for specific platforms.

This will override any platform setting in the recipes you’re building.

NOTE: Building for a different architecture than your hardware will require installing qemu. Build times will be much greater when building for a non-native architecture.

Source

pub fn maybe_platform( self, value: Option<Vec<Platform>>, ) -> BuildCommandBuilder<SetPlatform<S>>
where S::Platform: IsUnset,

Optional (Some / Option setters). Default: <Vec<Platform> as Default>::default().

Build for specific platforms.

This will override any platform setting in the recipes you’re building.

NOTE: Building for a different architecture than your hardware will require installing qemu. Build times will be much greater when building for a non-native architecture.

Source

pub fn compression_format( self, value: CompressionType, ) -> BuildCommandBuilder<SetCompressionFormat<S>>
where S::CompressionFormat: IsUnset,

Optional (Some / Option setters). Default: <CompressionType as Default>::default().

The compression format the images will be pushed in.

Source

pub fn maybe_compression_format( self, value: Option<CompressionType>, ) -> BuildCommandBuilder<SetCompressionFormat<S>>
where S::CompressionFormat: IsUnset,

Optional (Some / Option setters). Default: <CompressionType as Default>::default().

The compression format the images will be pushed in.

Source

pub fn retry_push(self, value: bool) -> BuildCommandBuilder<SetRetryPush<S>>
where S::RetryPush: IsUnset,

Optional (Some / Option setters). Default: false.

Enable retrying to push the image.

Source

pub fn maybe_retry_push( self, value: Option<bool>, ) -> BuildCommandBuilder<SetRetryPush<S>>
where S::RetryPush: IsUnset,

Optional (Some / Option setters). Default: false.

Enable retrying to push the image.

Source

pub fn retry_count(self, value: u8) -> BuildCommandBuilder<SetRetryCount<S>>
where S::RetryCount: IsUnset,

Optional (Some / Option setters). Default: 0.

The number of times to retry pushing the image.

Source

pub fn maybe_retry_count( self, value: Option<u8>, ) -> BuildCommandBuilder<SetRetryCount<S>>
where S::RetryCount: IsUnset,

Optional (Some / Option setters). Default: 0.

The number of times to retry pushing the image.

Source

pub fn archive( self, value: impl Into<PathBuf>, ) -> BuildCommandBuilder<SetArchive<S>>
where S::Archive: IsUnset,

Optional (Some / Option setters). Archives the built image into a tarfile in the specified directory.

Source

pub fn maybe_archive( self, value: Option<impl Into<PathBuf>>, ) -> BuildCommandBuilder<SetArchive<S>>
where S::Archive: IsUnset,

Optional (Some / Option setters). Archives the built image into a tarfile in the specified directory.

Source

pub fn registry_namespace( self, value: impl Into<String>, ) -> BuildCommandBuilder<SetRegistryNamespace<S>>
where S::RegistryNamespace: IsUnset,

Optional (Some / Option setters). The url path to your base project images.

Source

pub fn maybe_registry_namespace( self, value: Option<impl Into<String>>, ) -> BuildCommandBuilder<SetRegistryNamespace<S>>
where S::RegistryNamespace: IsUnset,

Optional (Some / Option setters). The url path to your base project images.

Source

pub fn no_sign(self, value: bool) -> BuildCommandBuilder<SetNoSign<S>>
where S::NoSign: IsUnset,

Optional (Some / Option setters). Default: false.

Do not sign the image on push.

Source

pub fn maybe_no_sign( self, value: Option<bool>, ) -> BuildCommandBuilder<SetNoSign<S>>
where S::NoSign: IsUnset,

Optional (Some / Option setters). Default: false.

Do not sign the image on push.

Source

pub fn squash(self, value: bool) -> BuildCommandBuilder<SetSquash<S>>
where S::Squash: IsUnset,

Optional (Some / Option setters). Default: false.

Runs all instructions inside one layer of the final image.

WARN: This doesn’t work with the docker driver as it has been deprecated.

NOTE: Squash has a performance benefit for podman and buildah when running inside a container.

Source

pub fn maybe_squash( self, value: Option<bool>, ) -> BuildCommandBuilder<SetSquash<S>>
where S::Squash: IsUnset,

Optional (Some / Option setters). Default: false.

Runs all instructions inside one layer of the final image.

WARN: This doesn’t work with the docker driver as it has been deprecated.

NOTE: Squash has a performance benefit for podman and buildah when running inside a container.

Source

pub fn build_chunked_oci( self, value: bool, ) -> BuildCommandBuilder<SetBuildChunkedOci<S>>
where S::BuildChunkedOci: IsUnset,

Optional (Some / Option setters). Default: false.

Uses rpm-ostree compose build-chunked-oci to rechunk the image, allowing for smaller images and smaller updates.

WARN: This will increase the build-time and take up more space during build-time.

Source

pub fn maybe_build_chunked_oci( self, value: Option<bool>, ) -> BuildCommandBuilder<SetBuildChunkedOci<S>>
where S::BuildChunkedOci: IsUnset,

Optional (Some / Option setters). Default: false.

Uses rpm-ostree compose build-chunked-oci to rechunk the image, allowing for smaller images and smaller updates.

WARN: This will increase the build-time and take up more space during build-time.

Source

pub fn max_layers( self, value: NonZeroU32, ) -> BuildCommandBuilder<SetMaxLayers<S>>
where S::MaxLayers: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_MAX_LAYERS.

Maximum number of layers to use when rechunking. Requires --build-chunked-oci.

Source

pub fn maybe_max_layers( self, value: Option<NonZeroU32>, ) -> BuildCommandBuilder<SetMaxLayers<S>>
where S::MaxLayers: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_MAX_LAYERS.

Maximum number of layers to use when rechunking. Requires --build-chunked-oci.

Source

pub fn remove_base_image( self, value: bool, ) -> BuildCommandBuilder<SetRemoveBaseImage<S>>
where S::RemoveBaseImage: IsUnset,

Optional (Some / Option setters). Default: false.

Removes the base image from local storage and prunes unused podman containers and volumes after the image is built, but before running build-chunked-oci. This frees up additional disk space.

Source

pub fn maybe_remove_base_image( self, value: Option<bool>, ) -> BuildCommandBuilder<SetRemoveBaseImage<S>>
where S::RemoveBaseImage: IsUnset,

Optional (Some / Option setters). Default: false.

Removes the base image from local storage and prunes unused podman containers and volumes after the image is built, but before running build-chunked-oci. This frees up additional disk space.

Source

pub fn rechunk(self, value: bool) -> BuildCommandBuilder<SetRechunk<S>>
where S::Rechunk: IsUnset,

Optional (Some / Option setters). Default: false.

Uses hhd-dev/rechunk to rechunk the image, allowing for smaller images and smaller updates.

WARN: This will be deprecated in the future.

WARN: This will increase the build-time and take up more space during build-time.

NOTE: This must be run as root!

Source

pub fn maybe_rechunk( self, value: Option<bool>, ) -> BuildCommandBuilder<SetRechunk<S>>
where S::Rechunk: IsUnset,

Optional (Some / Option setters). Default: false.

Uses hhd-dev/rechunk to rechunk the image, allowing for smaller images and smaller updates.

WARN: This will be deprecated in the future.

WARN: This will increase the build-time and take up more space during build-time.

NOTE: This must be run as root!

Source

pub fn rechunk_clear_plan( self, value: bool, ) -> BuildCommandBuilder<SetRechunkClearPlan<S>>
where S::RechunkClearPlan: IsUnset,

Optional (Some / Option setters). Default: false.

Use a fresh rechunk plan, regardless of previous ref.

NOTE: Only works with --build-chunked-oci or --rechunk.

Source

pub fn maybe_rechunk_clear_plan( self, value: Option<bool>, ) -> BuildCommandBuilder<SetRechunkClearPlan<S>>
where S::RechunkClearPlan: IsUnset,

Optional (Some / Option setters). Default: false.

Use a fresh rechunk plan, regardless of previous ref.

NOTE: Only works with --build-chunked-oci or --rechunk.

Source

pub fn tempdir(self, value: PathBuf) -> BuildCommandBuilder<SetTempdir<S>>
where S::Tempdir: IsUnset,

Optional (Some / Option setters). The location to temporarily store files while building. If unset, it will use /tmp.

Source

pub fn maybe_tempdir( self, value: Option<PathBuf>, ) -> BuildCommandBuilder<SetTempdir<S>>
where S::Tempdir: IsUnset,

Optional (Some / Option setters). The location to temporarily store files while building. If unset, it will use /tmp.

Source

pub fn cache_layers(self, value: bool) -> BuildCommandBuilder<SetCacheLayers<S>>
where S::CacheLayers: IsUnset,

Optional (Some / Option setters). Default: false.

Automatically cache build layers to the registry.

NOTE: Only works when using –push

Source

pub fn maybe_cache_layers( self, value: Option<bool>, ) -> BuildCommandBuilder<SetCacheLayers<S>>
where S::CacheLayers: IsUnset,

Optional (Some / Option setters). Default: false.

Automatically cache build layers to the registry.

NOTE: Only works when using –push

Source

pub fn skip_validation( self, value: bool, ) -> BuildCommandBuilder<SetSkipValidation<S>>
where S::SkipValidation: IsUnset,

Optional (Some / Option setters). Default: false.

Skips validation of the recipe file.

Source

pub fn maybe_skip_validation( self, value: Option<bool>, ) -> BuildCommandBuilder<SetSkipValidation<S>>
where S::SkipValidation: IsUnset,

Optional (Some / Option setters). Default: false.

Skips validation of the recipe file.

Source

pub fn credentials( self, value: CredentialsArgs, ) -> BuildCommandBuilder<SetCredentials<S>>
where S::Credentials: IsUnset,

Optional (Some / Option setters). Default: <CredentialsArgs as Default>::default().

Source

pub fn maybe_credentials( self, value: Option<CredentialsArgs>, ) -> BuildCommandBuilder<SetCredentials<S>>
where S::Credentials: IsUnset,

Optional (Some / Option setters). Default: <CredentialsArgs as Default>::default().

Source

pub fn drivers(self, value: DriverArgs) -> BuildCommandBuilder<SetDrivers<S>>
where S::Drivers: IsUnset,

Optional (Some / Option setters). Default: <DriverArgs as Default>::default().

Source

pub fn maybe_drivers( self, value: Option<DriverArgs>, ) -> BuildCommandBuilder<SetDrivers<S>>
where S::Drivers: IsUnset,

Optional (Some / Option setters). Default: <DriverArgs as Default>::default().

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> At for T

Source§

fn at<M>(self, metadata: M) -> Meta<T, M>

Wraps self inside a Meta<Self, M> using the given metadata. 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> BorrowStripped for T

Source§

fn stripped(&self) -> &Stripped<T>

Source§

impl<T> BorrowUnordered for T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<T> UnsafeAny for T
where T: Any,