cargo_gazelle::config

Struct CrateConfig

Source
pub struct CrateConfig {
    skip_generating: bool,
    additive_content: Option<String>,
    lib: LibraryConfig,
    build: BuildConfig,
    tests: BTreeMap<String, TestConfig>,
    binaries: BTreeMap<String, BinaryConfig>,
}
Expand description

Extra configuration for the Bazel targets generated for a crate.

We should try to make generating BUILD.bazel files is as seamless as possible, but there are instances where this isn’t possible. For example, some tests rely on text-based snapshot files that Bazel needs to know about so it can include them in the sandbox. But Rust/Cargo has no way of formally declaring a dependency on these files so we must manually specify them.

Fields§

§skip_generating: bool

Should we skip generating a BUILD.bazel file entirely for this crate.

§additive_content: Option<String>

Additive content we paste at the bottom of the generated BUILD.bazel file.

§lib: LibraryConfig

Extra config for the rust_library target.

§build: BuildConfig

Extra config for the cargo_build_script target.

§tests: BTreeMap<String, TestConfig>

Extra config for any test targets.

§binaries: BTreeMap<String, BinaryConfig>

Extra config for any binary targets.

Implementations§

Source§

impl CrateConfig

Source

pub fn new(package: &PackageMetadata<'_>) -> Self

Source

pub fn skip_generating(&self) -> bool

Source

pub fn additive_content(&self) -> Option<AdditiveContent>

Source

pub fn lib(&self) -> &LibraryConfig

Source

pub fn lib_test(&self) -> &TestConfig

Source

pub fn doc_test(&self) -> &TestConfig

Source

pub fn build(&self) -> &BuildConfig

Source

pub fn test(&self, name: &str) -> &TestConfig

Source

pub fn binary(&self, name: &str) -> &BinaryConfig

Trait Implementations§

Source§

impl Debug for CrateConfig

Source§

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

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

impl Default for CrateConfig

Source§

fn default() -> CrateConfig

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

impl<'de> Deserialize<'de> for CrateConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

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> 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, 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,