Struct stack_graphs::graph::StackGraph
source · [−]pub struct StackGraph { /* private fields */ }
Expand description
Contains all of the nodes and edges that make up a stack graph.
Implementations
sourceimpl StackGraph
impl StackGraph
sourcepub fn add_symbol<S: AsRef<str> + ?Sized>(
&mut self,
symbol: &S
) -> Handle<Symbol>
pub fn add_symbol<S: AsRef<str> + ?Sized>(
&mut self,
symbol: &S
) -> Handle<Symbol>
Adds a symbol to the stack graph, ensuring that there’s only ever one copy of a particular symbol stored in the graph.
sourcepub fn iter_symbols(&self) -> impl Iterator<Item = Handle<Symbol>>
pub fn iter_symbols(&self) -> impl Iterator<Item = Handle<Symbol>>
Returns an iterator over all of the handles of all of the symbols in this stack graph.
(Note that because we’re only returning handles, this iterator does not retain a
reference to the StackGraph
.)
sourceimpl StackGraph
impl StackGraph
sourcepub fn add_string<S: AsRef<str> + ?Sized>(
&mut self,
string: &S
) -> Handle<InternedString>
pub fn add_string<S: AsRef<str> + ?Sized>(
&mut self,
string: &S
) -> Handle<InternedString>
Adds an interned string to the stack graph, ensuring that there’s only ever one copy of a particular string stored in the graph.
sourcepub fn iter_strings(&self) -> impl Iterator<Item = Handle<InternedString>>
pub fn iter_strings(&self) -> impl Iterator<Item = Handle<InternedString>>
Returns an iterator over all of the handles of all of the interned strings in this stack
graph. (Note that because we’re only returning handles, this iterator does not retain a
reference to the StackGraph
.)
sourceimpl StackGraph
impl StackGraph
sourcepub fn add_file<S: AsRef<str> + ?Sized>(
&mut self,
name: &S
) -> Result<Handle<File>, Handle<File>>
pub fn add_file<S: AsRef<str> + ?Sized>(
&mut self,
name: &S
) -> Result<Handle<File>, Handle<File>>
Adds a file to the stack graph. There can only ever be one file with a particular name in
the graph. If a file with the requested name already exists, we return Err
; if it
doesn’t already exist, we return Ok
. In both cases, the value of the result is the
file’s handle.
sourcepub fn get_or_create_file<S: AsRef<str> + ?Sized>(
&mut self,
name: &S
) -> Handle<File>
pub fn get_or_create_file<S: AsRef<str> + ?Sized>(
&mut self,
name: &S
) -> Handle<File>
Adds a file to the stack graph, returning its handle. There can only ever be one file with a particular name in the graph, so if you call this multiple times with the same name, you’ll get the same handle each time.
sourceimpl StackGraph
impl StackGraph
sourcepub fn nodes_for_file(
&self,
file: Handle<File>
) -> impl Iterator<Item = Handle<Node>> + '_
pub fn nodes_for_file(
&self,
file: Handle<File>
) -> impl Iterator<Item = Handle<Node>> + '_
Returns an iterator of all of the nodes that belong to a particular file. Note that this does not include the singleton root or jump to scope nodes.
sourcepub fn iter_files(&self) -> impl Iterator<Item = Handle<File>> + '_
pub fn iter_files(&self) -> impl Iterator<Item = Handle<File>> + '_
Returns an iterator over all of the handles of all of the files in this stack graph. (Note
that because we’re only returning handles, this iterator does not retain a reference to
the StackGraph
.)
sourceimpl StackGraph
impl StackGraph
sourcepub fn jump_to_node() -> Handle<Node>
pub fn jump_to_node() -> Handle<Node>
Returns a handle to the stack graph’s singleton jump to scope node.
sourcepub fn new_node_id(&mut self, file: Handle<File>) -> NodeID
pub fn new_node_id(&mut self, file: Handle<File>) -> NodeID
Returns an unused NodeID
for the given file.
sourcepub fn iter_nodes(&self) -> impl Iterator<Item = Handle<Node>>
pub fn iter_nodes(&self) -> impl Iterator<Item = Handle<Node>>
Returns an iterator of all of the nodes in the graph. (Note that because we’re only
returning handles, this iterator does not retain a reference to the StackGraph
.)
sourceimpl StackGraph
impl StackGraph
sourceimpl StackGraph
impl StackGraph
sourceimpl StackGraph
impl StackGraph
sourceimpl StackGraph
impl StackGraph
sourceimpl StackGraph
impl StackGraph
sourceimpl StackGraph
impl StackGraph
sourceimpl StackGraph
impl StackGraph
sourceimpl StackGraph
impl StackGraph
sourcepub fn source_info(&self, node: Handle<Node>) -> Option<&SourceInfo>
pub fn source_info(&self, node: Handle<Node>) -> Option<&SourceInfo>
Returns information about the source code that a stack graph node represents.
sourcepub fn source_info_mut(&mut self, node: Handle<Node>) -> &mut SourceInfo
pub fn source_info_mut(&mut self, node: Handle<Node>) -> &mut SourceInfo
Returns a mutable reference to the information about the source code that a stack graph node represents.
sourceimpl StackGraph
impl StackGraph
sourceimpl StackGraph
impl StackGraph
sourcepub fn new() -> StackGraph
pub fn new() -> StackGraph
Creates a new, initially empty stack graph.
sourcepub fn add_from_graph(&mut self, other: &StackGraph) -> Result<(), Handle<File>>
pub fn add_from_graph(&mut self, other: &StackGraph) -> Result<(), Handle<File>>
Copies the given stack graph into this stack graph. Panics if any of the files in the other stack graph are already defined in the current one.
Trait Implementations
sourceimpl Default for StackGraph
impl Default for StackGraph
sourcefn default() -> StackGraph
fn default() -> StackGraph
Returns the “default value” for a type. Read more
sourceimpl Index<Handle<File>> for StackGraph
impl Index<Handle<File>> for StackGraph
sourceimpl Index<Handle<InternedString>> for StackGraph
impl Index<Handle<InternedString>> for StackGraph
sourceimpl Index<Handle<Node>> for StackGraph
impl Index<Handle<Node>> for StackGraph
sourceimpl Index<Handle<Symbol>> for StackGraph
impl Index<Handle<Symbol>> for StackGraph
Auto Trait Implementations
impl RefUnwindSafe for StackGraph
impl !Send for StackGraph
impl !Sync for StackGraph
impl Unpin for StackGraph
impl UnwindSafe for StackGraph
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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> FmtForward for T
impl<T> FmtForward for T
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes self
to use its Binary
implementation when Debug
-formatted.
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes self
to use its Octal
implementation when Debug
-formatted.
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
Pipes by value. This is generally the method you want to use. Read more
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows self
and passes that borrow into the pipe function. Read more
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows self
and passes that borrow into the pipe function. Read more
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.borrow()
into the pipe function. Read more
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.borrow_mut()
into the pipe
function. Read more
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.as_ref()
into the pipe function.
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.deref()
into the pipe function.
impl<T> Tap for T
impl<T> Tap for T
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Immutable access to the Borrow<B>
of a value. Read more
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the BorrowMut<B>
of a value. Read more
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
Immutable access to the AsRef<R>
view of a value. Read more
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
Mutable access to the AsMut<R>
view of a value. Read more
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
Immutable access to the Deref::Target
of a value. Read more
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Mutable access to the Deref::Target
of a value. Read more
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap()
only in debug builds, and is erased in release builds.
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
Calls .tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
Calls .tap_ref()
only in debug builds, and is erased in release
builds. Read more
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
Calls .tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more