Struct rpkg_rs::misc::resource_id::ResourceID

pub struct ResourceID { /* private fields */ }

Implementations

impl ResourceID

pub fn new() -> Self

pub fn create_derived(&self, parameters: &str, extension: &str) -> ResourceID

Create a derived ResourceID from a existing one. This nests the original ResourceID

    let resource_id = ResourceID::from_str("[assembly:/_pro/_test/usern/materialclasses/ball_of_water_b.materialclass].pc_fx")?;
    let derived = resource_id.create_derived("dx11", "mate");
    assert_eq!(derived.resource_path(), "[[assembly:/_pro/_test/usern/materialclasses/ball_of_water_b.materialclass].fx](dx11).pc_mate");

pub fn create_aspect(&self, ids: Vec<&ResourceID>) -> ResourceID

Create a ResourceID with aspect parameters

  
    let resource_id = ResourceID::from_str("[assembly:/templates/aspectdummy.aspect].pc_entitytype")?;
    let sub_id_1 = ResourceID::from_str("[assembly:/_pro/effects/geometry/water.prim].pc_entitytype")?;
    let sub_id_2 = ResourceID::from_str("[modules:/zdisablecameracollisionaspect.class].entitytype")?;

    let aspect = resource_id.create_aspect(vec![&sub_id_1, &sub_id_2]);

    assert_eq!(aspect.resource_path(), "[assembly:/templates/aspectdummy.aspect]([assembly:/_pro/effects/geometry/water.prim].entitytype,[modules:/zdisablecameracollisionaspect.class].entitytype).pc_entitytype");

pub fn add_parameter(&mut self, param: &str)

pub fn resource_path(&self) -> String

Get the resource path. Will append the platform tag

pub fn inner_most_resource_path(&self) -> ResourceID

Get the base ResourceID within a derived ResourceID

    let resource_id = ResourceID::from_str("[[[assembly:/_pro/_test/usern/materialclasses/ball_of_water_b.materialclass].fx](dx11).mate](dx12).pc_mate")?;
    let inner_most_path = resource_id.inner_most_resource_path();
    assert_eq!(inner_most_path.resource_path(), "[assembly:/_pro/_test/usern/materialclasses/ball_of_water_b.materialclass].pc_fx");

pub fn inner_resource_path(&self) -> ResourceID

Get the base ResourceID within a derived ResourceID

  
    let resource_id = ResourceID::from_str("[[[assembly:/_pro/_test/usern/materialclasses/ball_of_water_b.materialclass].fx](dx11).mate](dx12).pc_mate")?;
    let inner_path = resource_id.inner_resource_path();

    assert_eq!(inner_path.resource_path(), "[[assembly:/_pro/_test/usern/materialclasses/ball_of_water_b.materialclass].fx](dx11).pc_mate");
}

pub fn protocol(&self) -> Option<String>

pub fn parameters(&self) -> Vec<String>

pub fn path(&self) -> Option<String>

pub fn is_empty(&self) -> bool

pub fn is_valid(&self) -> bool

pub fn into_rrid(self) -> RuntimeResourceID

Trait Implementations

impl Clone for ResourceID

fn clone(&self) -> ResourceID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceID

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

Formats the value using the given formatter.

impl Default for ResourceID

fn default() -> ResourceID

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResourceID

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResourceID> for RuntimeResourceID

fn from(value: ResourceID) -> Self

Converts to this type from the input type.

impl FromStr for ResourceID

type Err = ResourceIDError

The associated error which can be returned from parsing.

fn from_str(source: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ResourceID

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 for ResourceID

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ResourceID

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ResourceID

impl StructuralPartialEq for ResourceID