Skip to main content

MethodInfo

Struct MethodInfo 

Source
pub struct MethodInfo { /* private fields */ }
Expand description

Metadata for a single method, used to build the LCOM4 method graph.

Each method carries its name, the set of fields it accesses, and the set of other methods on the same type that it calls directly. Field names and method names are plain strings extracted by the caller from HIR or other analysis passes.

§Examples

use std::collections::BTreeSet;
use whitaker_common::lcom4::MethodInfo;

let method = MethodInfo::new(
    "process",
    BTreeSet::from(["data".into(), "buffer".into()]),
    BTreeSet::new(),
);

assert_eq!(method.name(), "process");
assert!(method.accessed_fields().contains("data"));
assert!(method.called_methods().is_empty());

Implementations§

Source§

impl MethodInfo

Source

pub fn new( name: impl Into<String>, accessed_fields: BTreeSet<String>, called_methods: BTreeSet<String>, ) -> Self

Creates a new MethodInfo with the given name, accessed fields, and called methods.

§Examples
use std::collections::BTreeSet;
use whitaker_common::lcom4::MethodInfo;

let m = MethodInfo::new(
    "process",
    BTreeSet::from(["data".into()]),
    BTreeSet::from(["validate".into()]),
);
assert_eq!(m.name(), "process");
Source

pub fn name(&self) -> &str

Returns the method name.

§Examples
use std::collections::BTreeSet;
use whitaker_common::lcom4::MethodInfo;

let m = MethodInfo::new("read", BTreeSet::new(), BTreeSet::new());
assert_eq!(m.name(), "read");
Source

pub fn accessed_fields(&self) -> &BTreeSet<String>

Returns the set of field names accessed by this method.

§Examples
use std::collections::BTreeSet;
use whitaker_common::lcom4::MethodInfo;

let m = MethodInfo::new(
    "read",
    BTreeSet::from(["buf".into()]),
    BTreeSet::new(),
);
assert!(m.accessed_fields().contains("buf"));
Source

pub fn called_methods(&self) -> &BTreeSet<String>

Returns the set of method names called directly by this method.

§Examples
use std::collections::BTreeSet;
use whitaker_common::lcom4::MethodInfo;

let m = MethodInfo::new(
    "process",
    BTreeSet::new(),
    BTreeSet::from(["validate".into()]),
);
assert!(m.called_methods().contains("validate"));

Trait Implementations§

Source§

impl Clone for MethodInfo

Source§

fn clone(&self) -> MethodInfo

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MethodInfo

Source§

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

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

impl Eq for MethodInfo

Source§

impl PartialEq for MethodInfo

Source§

fn eq(&self, other: &MethodInfo) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MethodInfo

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.