pub struct BuildScriptOptions { /* private fields */ }
Expand description
Type to store any (optional) options for the build script.
Implementations§
Source§impl BuildScriptOptions
impl BuildScriptOptions
Sourcepub fn collect_runtime_dependencies(
self,
collect_dependencies: DependencyDepth,
) -> Self
pub fn collect_runtime_dependencies( self, collect_dependencies: DependencyDepth, ) -> Self
Enables and disables runtime dependency collection.
Dependency data is fairly large, which may cause problems, mainly by crashing the build process. If the project compiles successfully with dependency collection enabled, you are probably fine.
Sourcepub fn collect_build_dependencies(
self,
collect_dependencies: DependencyDepth,
) -> Self
pub fn collect_build_dependencies( self, collect_dependencies: DependencyDepth, ) -> Self
Enables and disables build dependency collection.
Dependency data is fairly large, which may cause problems, mainly by crashing the build process. If the project compiles successfully with dependency collection enabled, you are probably fine.
Sourcepub fn collect_dev_dependencies(
self,
collect_dependencies: DependencyDepth,
) -> Self
pub fn collect_dev_dependencies( self, collect_dependencies: DependencyDepth, ) -> Self
Enables and disables dev dependency collection.
Dependency data is fairly large, which may cause problems, mainly by crashing the build process. If the project compiles successfully with dependency collection enabled, you are probably fine.
Sourcepub fn collect_dependencies(self, collect_dependencies: DependencyDepth) -> Self
pub fn collect_dependencies(self, collect_dependencies: DependencyDepth) -> Self
Enables and disables runtime, build and dev dependency collection.
Dependency data is fairly large, which may cause problems, mainly by crashing the build process. If the project compiles successfully with dependency collection enabled, you are probably fine.
Source§impl BuildScriptOptions
impl BuildScriptOptions
Sourcepub fn build_timestamp(self, timestamp: DateTime<Utc>) -> Self
pub fn build_timestamp(self, timestamp: DateTime<Utc>) -> Self
Set the build timestamp by hand.
This is mostly important for reproducible builds using only cargo. If possible, consider setting the environment
variable SOURCE_DATE_EPOCH
instead, which does not
require any setup.
Sourcepub fn build_timestamp_as_nanos(self, nanos: i64) -> Self
pub fn build_timestamp_as_nanos(self, nanos: i64) -> Self
Set the build timestamp by hand as nanosecond-precise UNIX timestamp.
This is mostly important for reproducible builds using only cargo. If possible, consider setting the environment
variable SOURCE_DATE_EPOCH
instead, which does not
require any setup.
Trait Implementations§
Source§impl Default for BuildScriptOptions
impl Default for BuildScriptOptions
Source§impl Drop for BuildScriptOptions
impl Drop for BuildScriptOptions
Source§impl From<BuildScriptOptions> for BuildInfo
impl From<BuildScriptOptions> for BuildInfo
Source§fn from(opts: BuildScriptOptions) -> BuildInfo
fn from(opts: BuildScriptOptions) -> BuildInfo
Auto Trait Implementations§
impl Freeze for BuildScriptOptions
impl RefUnwindSafe for BuildScriptOptions
impl Send for BuildScriptOptions
impl Sync for BuildScriptOptions
impl Unpin for BuildScriptOptions
impl UnwindSafe for BuildScriptOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);