Struct ra_ap_ide::CrateGraph
[−]pub struct CrateGraph { /* private fields */ }
Expand description
CrateGraph
is a bit of information which turns a set of text files into a
number of Rust crates.
Each crate is defined by the FileId
of its root module, the set of enabled
cfg
flags and the set of dependencies.
Note that, due to cfg’s, there might be several crates for a single FileId
!
For the purposes of analysis, a crate does not have a name. Instead, names are specified on dependency edges. That is, a crate might be known under different names in different dependent crates.
Note that CrateGraph
is build-system agnostic: it’s a concept of the Rust
language proper, not a concept of the build system. In practice, we get
CrateGraph
by lowering cargo metadata
output.
CrateGraph
is !Serialize
by design, see
https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/dev/architecture.md#serialization
Implementations
impl CrateGraph
impl CrateGraph
pub fn add_crate_root(
&mut self,
file_id: FileId,
edition: Edition,
display_name: Option<CrateDisplayName>,
version: Option<String>,
cfg_options: CfgOptions,
potential_cfg_options: CfgOptions,
env: Env,
proc_macro: Vec<ProcMacro, Global>,
origin: CrateOrigin
) -> CrateId
pub fn add_dep(
&mut self,
from: CrateId,
dep: Dependency
) -> Result<(), CyclicDependenciesError>
pub fn is_empty(&self) -> bool
pub fn iter(&self) -> impl Iterator<Item = CrateId>
pub fn transitive_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId>
pub fn transitive_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId>
Returns an iterator over all transitive dependencies of the given crate, including the crate itself.
pub fn transitive_rev_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId>
pub fn transitive_rev_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId>
Returns all transitive reverse dependencies of the given crate, including the crate itself.
pub fn crates_in_topological_order(&self) -> Vec<CrateId, Global>
pub fn crates_in_topological_order(&self) -> Vec<CrateId, Global>
Returns all crates in the graph, sorted in topological order (ie. dependencies of a crate come before the crate itself).
pub fn crate_id_for_crate_root(&self, file_id: FileId) -> Option<CrateId>
pub fn extend(&mut self, other: CrateGraph) -> u32
pub fn extend(&mut self, other: CrateGraph) -> u32
Extends this crate graph by adding a complete disjoint second crate graph.
The ids of the crates in the other
graph are shifted by the return
amount.
pub fn patch_cfg_if(&mut self) -> bool
Trait Implementations
impl Clone for CrateGraph
impl Clone for CrateGraph
fn clone(&self) -> CrateGraph
fn clone(&self) -> CrateGraph
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for CrateGraph
impl Debug for CrateGraph
impl Default for CrateGraph
impl Default for CrateGraph
fn default() -> CrateGraph
fn default() -> CrateGraph
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl RefUnwindSafe for CrateGraph
impl Send for CrateGraph
impl Sync for CrateGraph
impl Unpin for CrateGraph
impl UnwindSafe for CrateGraph
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Cast for T
impl<T> Cast for T
fn cast<U>(self, interner: <U as HasInterner>::Interner) -> U where
Self: CastTo<U>,
U: HasInterner,
fn cast<U>(self, interner: <U as HasInterner>::Interner) -> U where
Self: CastTo<U>,
U: HasInterner,
Cast a value to type U
using CastTo
.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more