Struct librojo::Project

source · [−]

pub struct Project {
    pub name: String,
    pub tree: ProjectNode,
    pub serve_port: Option<u16>,
    pub serve_place_ids: Option<HashSet<u64>>,
    pub place_id: Option<u64>,
    pub game_id: Option<u64>,
    pub serve_address: Option<IpAddr>,
    pub glob_ignore_paths: Vec<Glob>,
    pub file_location: PathBuf,
}

Expand description

Contains all of the configuration for a Rojo-managed project.

Project files are stored in .project.json files.

Fields

name: String

The name of the top-level instance described by the project.

tree: ProjectNode

The tree of instances described by this project. Projects always describe at least one instance.

serve_port: Option<u16>

If specified, sets the default port that rojo serve should use when using this project for live sync.

serve_place_ids: Option<HashSet<u64>>

If specified, contains the set of place IDs that this project is compatible with when doing live sync.

This setting is intended to help prevent syncing a Rojo project into the wrong Roblox place.

place_id: Option<u64>

If specified, sets the current place’s place ID when connecting to the Rojo server from Roblox Studio.

game_id: Option<u64>

If specified, sets the current place’s game ID when connecting to the Rojo server from Roblox Studio.

serve_address: Option<IpAddr>

If specified, this address will be used in place of the default address As long as –address is unprovided.

glob_ignore_paths: Vec<Glob>

A list of globs, relative to the folder the project file is in, that match files that should be excluded if Rojo encounters them.

file_location: PathBuf

The path to the file that this project came from. Relative paths in the project should be considered relative to the parent of this field, also given by Project::folder_location.

Implementations

impl Project

pub fn is_project_file(path: &Path) -> bool

Tells whether the given path describes a Rojo project.

pub fn load_from_slice(
contents: &[u8 ],
project_file_location: &Path
) -> Result<Self, ProjectError>

pub fn load_fuzzy(
fuzzy_project_location: &Path
) -> Result<Option<Self>, ProjectError>

pub fn folder_location(&self) -> &Path

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Project

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Project

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<Project> for Project

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

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

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

This method tests for !=.

impl Serialize for Project

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Project

Auto Trait Implementations

impl RefUnwindSafe for Project

impl Send for Project

impl Sync for Project

impl Unpin for Project

impl UnwindSafe for Project

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,