Struct aquascope::analysis::permissions::PermissionsData

pub struct PermissionsData {
    pub type_droppable: bool,
    pub type_writeable: bool,
    pub type_copyable: bool,
    pub is_live: bool,
    pub path_uninitialized: bool,
    pub path_moved: Option<MoveKey>,
    pub loan_read_refined: Option<LoanKey>,
    pub loan_write_refined: Option<LoanKey>,
    pub loan_drop_refined: Option<LoanKey>,
    pub permissions: Permissions,
}

Permissions and first-order provenance for permission refinement.

In contrast to Permissions, the PermissionsData stores all relevant information about what factors into the permissions. Things like declared type information, loan refinements, move refinements, etc. PermissionsData corresponds to a single Place.

Fields

type_droppable: bool

Was the type declared as droppable (i.e. an owned value)?

type_writeable: bool

Was the type declared as writeable (i.e. is it mut)?

type_copyable: bool

Is the type copyable (i.e. does it implement the Copy trait)?

is_live: bool

Is the Place currently live?

path_uninitialized: bool

Is this place uninitialized?

path_moved: Option<MoveKey>

Is the Place currently uninitialized due to a move?

loan_read_refined: Option<LoanKey>

Is a live loan removing read permissions?

loan_write_refined: Option<LoanKey>

Is a live loan removing write permissions?

loan_drop_refined: Option<LoanKey>

Is a live loan removing drop permissions?

permissions: Permissions

Computed permissions given the above information.

Trait Implementations

impl Clone for PermissionsData

fn clone(&self) -> PermissionsData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PermissionsData

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

Formats the value using the given formatter.

impl Difference for PermissionsData

type Diff = PermissionsDataDiff

fn diff(&self, rhs: PermissionsData) -> Self::Diff

impl Hash for PermissionsData

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<PermissionsData> for PermissionsData

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PermissionsData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for PermissionsData

const EXPORT_TO: Option<&'static str> = _

fn decl() -> String

Declaration of this type, e.g. interface User { user_id: number, ... }. This function will panic if the type has no declaration.

fn name() -> String

Name of this type in TypeScript.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten an type declaration.
This function will panic if the type cannot be flattened.

fn dependencies() -> Vec<Dependency>

Information about types this type depends on. This is used for resolving imports when exporting to a file.

fn transparent() -> bool

true if this is a transparent type, e.g tuples or a list.
This is used for resolving imports when using the export! macro.

fn name_with_type_args(args: Vec<String, Global>) -> String

Name of this type in TypeScript, with type arguments.

fn export() -> Result<(), ExportError>

Manually export this type to a file. The output file can be specified by annotating the type with #[ts(export_to = ".."]. By default, the filename will be derived from the types name.

fn export_to(path: impl AsRef<Path>) -> Result<(), ExportError>

Manually export this type to a file with a file with the specified path. This function will ignore the #[ts(export_to = "..)] attribute.

fn export_to_string() -> Result<String, ExportError>

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

impl Copy for PermissionsData

impl Eq for PermissionsData

impl StructuralEq for PermissionsData

impl StructuralPartialEq for PermissionsData