Struct libdonet::dcfile::DCFile

pub struct DCFile<'dc> {
    baked_hash: DCFileHash,
    structs: Vec<DCStruct>,
    dclasses: Vec<DClass<'dc>>,
    imports: Vec<PyModuleImport>,
    keywords: Vec<DCKeyword>,
    type_defs: Vec<DCTypeDefinition>,
    field_id_2_field: Vec<&'dc DCField<'dc>>,
    all_object_valid: bool,
    inherited_fields_stale: bool,
}

Data model that provides a high level representation of a single, or collection, of DC files and their elements such as class imports, type definitions, structures, and Distributed Classes.

Fields

baked_hash: DCFileHash

structs: Vec<DCStruct>

dclasses: Vec<DClass<'dc>>

imports: Vec<PyModuleImport>

keywords: Vec<DCKeyword>

type_defs: Vec<DCTypeDefinition>

field_id_2_field: Vec<&'dc DCField<'dc>>

all_object_valid: bool

inherited_fields_stale: bool

Implementations

impl<'dc> DCFile<'dc>

pub(crate) fn new( structs: Vec<DCStruct>, dclasses: Vec<DClass<'dc>>, imports: Vec<PyModuleImport>, keywords: Vec<DCKeyword>, type_defs: Vec<DCTypeDefinition>, field_id_2_field: Vec<&'dc DCField<'dc>>, all_object_valid: bool, inherited_fields_stale: bool, ) -> Self

pub fn get_hash(&self) -> DCFileHash

Returns a 32-bit hash index associated with this file. This number is guaranteed to be consistent if the contents of the file have not changed, and it is very likely to be different if the contents of the file do change.

If called more than once, it will reuse the already calculated hash, as this structure is guaranteed to be immutable after initialization.

pub fn get_pretty_hash(&self) -> String

Returns a string with the hash as a pretty format hexadecimal.

pub fn get_num_imports(&self) -> usize

pub fn get_python_import(&self, index: usize) -> PyModuleImport

pub fn get_num_keywords(&self) -> usize

pub fn get_keyword(&self, _index: usize) -> &'dc DCKeyword

pub fn has_keyword(&self, _keyword: String) -> bool

pub fn get_num_dclasses(&self) -> usize

pub fn get_dclass(&self, _index: usize) -> &'dc DClass<'_>

pub fn get_dclass_by_id(&self, id: DClassId) -> &'dc DClass<'_>

pub fn get_dclass_by_name(&self, _name: &str) -> &'dc DClass<'_>

pub fn get_num_structs(&self) -> usize

pub fn get_struct(&self, _index: usize) -> &'dc DCStruct

Trait Implementations

impl<'dc> DCHash for DCFile<'dc>

fn generate_hash(&self, hashgen: &mut DCHashGenerator)

Accumulates the properties of this DC element into the file hash.

impl<'dc> Debug for DCFile<'dc>

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

Formats the value using the given formatter.

impl<'dc> Display for DCFile<'dc>

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

Formats the value using the given formatter.