Struct cobble_core::instance::InstanceBuilder

source · [−]

pub struct InstanceBuilder { /* private fields */ }

Expand description

Builder for Instance.

Implementations

source

impl InstanceBuilder

source

pub fn uuid(&mut self, value: Uuid) -> &mut Self

Instance UUID.

Defaults to uuid::Uuid::new_v4() when using InstanceBuilder.

source

pub fn name(&mut self, value: String) -> &mut Self

Name of the instance.

source

pub fn description(&mut self, value: String) -> &mut Self

Description of the instance.

Default to an empty string when using InstanceBuilder.

source

pub fn version(&mut self, value: String) -> &mut Self

Minecraft version used by the instance.

source

pub fn instance_path(&mut self, value: String) -> &mut Self

Path for the instance. This path contains the .minecraft folder and the version data JSON.

source

pub fn libraries_path(&mut self, value: String) -> &mut Self

Path for libraries.

source

pub fn assets_path(&mut self, value: String) -> &mut Self

Path for assets.

source

pub fn use_fullscreen(&mut self, value: bool) -> &mut Self

Launches the game in fullscreen mode. When set to true, the window size is ignored.

Defaults to false when using InstanceBuilder.

source

pub fn enable_window_size(&mut self, value: bool) -> &mut Self

Enables a custom resolution for the game window. Only has an effect when game is not launched in fullscreen mode.

Defaults to false when using InstanceBuilder.

source

pub fn window_width(&mut self, value: u32) -> &mut Self

Game window width. Used when enable_window_size is set to true.

Defaults to 1280 when using InstanceBuilder.

source

pub fn window_height(&mut self, value: u32) -> &mut Self

Game window height. Used when enable_window_size is set to true.

Defaults to 720 when using InstanceBuilder.

source

pub fn enable_memory(&mut self, value: bool) -> &mut Self

Enables custom memory JVM arguments.

Defaults to false when using InstanceBuilder.

source

pub fn min_memory(&mut self, value: u32) -> &mut Self

JVM initial heap size in megabytes. Adds the -Xms option to the command. Gets added before jvm_args.

Defaults to 1024 when using InstanceBuilder.

source

pub fn max_memory(&mut self, value: u32) -> &mut Self

JVM max heap size in megabytes. Adds the -Xmx option to the command. Gets added before jvm_args`.

Defaults to 2048 when using InstanceBuilder.

source

pub fn enable_java_exec(&mut self, value: bool) -> &mut Self

Enables a custom java executable. Launching an instance tries to use the instances java_exec when enabled, then tries java_exec for

Defaults to false when using InstanceBuilder.

source

pub fn java_exec(&mut self, value: String) -> &mut Self

Java executable used to launch minecraft.

Defaults to java when using InstanceBuilder.

source

pub fn enable_jvm_args(&mut self, value: bool) -> &mut Self

Enables custom JVM arguments. When disabled and the version data provides JVM arguments, the arguments from the version data are used. When enabled, arguments from version data are ignored.

Defaults to false when using InstanceBuilder.

source

pub fn jvm_args(&mut self, value: String) -> &mut Self

Custom JVM arguments.

Defaults to and empty string when using InstanceBuilder.

source

pub fn created(&mut self, value: OffsetDateTime) -> &mut Self

Created timestamp.

Defaults to time::OffsetDateTime::now_utc() when using InstanceBuilder.

source

pub fn build(&self) -> Result<Instance, InstanceBuilderError>

Builds a new Instance.

Errors

If a required field has not been initialized.

Trait Implementations

source

impl Clone for InstanceBuilder

source

fn clone(&self) -> InstanceBuilder

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

source

impl Default for InstanceBuilder

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for InstanceBuilder

impl Send for InstanceBuilder

impl Sync for InstanceBuilder

impl Unpin for InstanceBuilder

impl UnwindSafe for InstanceBuilder

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> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

impl<T, U> Into 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.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

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 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct cobble_core::instance::InstanceBuilder

Implementations

impl InstanceBuilder

pub fn uuid(&mut self, value: Uuid) -> &mut Self

pub fn name(&mut self, value: String) -> &mut Self

pub fn description(&mut self, value: String) -> &mut Self

pub fn version(&mut self, value: String) -> &mut Self

pub fn instance_path(&mut self, value: String) -> &mut Self

pub fn libraries_path(&mut self, value: String) -> &mut Self

pub fn assets_path(&mut self, value: String) -> &mut Self

pub fn use_fullscreen(&mut self, value: bool) -> &mut Self

pub fn enable_window_size(&mut self, value: bool) -> &mut Self

pub fn window_width(&mut self, value: u32) -> &mut Self

pub fn window_height(&mut self, value: u32) -> &mut Self

pub fn enable_memory(&mut self, value: bool) -> &mut Self

pub fn min_memory(&mut self, value: u32) -> &mut Self

pub fn max_memory(&mut self, value: u32) -> &mut Self

pub fn enable_java_exec(&mut self, value: bool) -> &mut Self

pub fn java_exec(&mut self, value: String) -> &mut Self

pub fn enable_jvm_args(&mut self, value: bool) -> &mut Self

pub fn jvm_args(&mut self, value: String) -> &mut Self

pub fn created(&mut self, value: OffsetDateTime) -> &mut Self

pub fn build(&self) -> Result<Instance, InstanceBuilderError>

Errors

Trait Implementations

impl Clone for InstanceBuilder

fn clone(&self) -> InstanceBuilder

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

impl Default for InstanceBuilder

fn default() -> Self

Auto Trait Implementations

impl RefUnwindSafe for InstanceBuilder

impl Send for InstanceBuilder

impl Sync for InstanceBuilder

impl Unpin for InstanceBuilder

impl UnwindSafe for InstanceBuilder

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

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

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

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