Skip to main content

Launcher

Struct Launcher 

Source
pub struct Launcher { /* private fields */ }

Implementations§

Source§

impl Launcher

Source

pub fn new(options: LaunchOptions) -> Self

Source

pub fn options(&self) -> &LaunchOptions

Source

pub fn game_data(&self) -> Option<&GameData>

Source

pub async fn download_game( &mut self, event_tx: Sender<LaunchEvent>, ) -> Result<(), LaunchError>

Download, verify, and optionally install a mod loader for the configured Minecraft version. Stores the result in self.game_data.

Emits progress events on event_tx. After this call, Launcher::launch can be invoked without downloading again.

If there is no internet connection and a valid cache exists, the cache is loaded without network access. If there is no cache either, returns LaunchError::NoInternetNoCache.

Source

pub async fn launch( &self, event_tx: Sender<LaunchEvent>, ) -> Result<Child, LaunchError>

Assemble the Java command line and spawn the Minecraft process.

Resolves game data from self.game_data (set by Launcher::download_game) or, if absent, from the persisted cache on disk. Returns LaunchError::GameDataNotReady if neither is available.

Stdout and stderr are piped; each line is forwarded as a LaunchEvent::Data event. The caller is responsible for calling child.wait() and emitting LaunchEvent::Close when appropriate.

Source

pub async fn start( &mut self, event_tx: Sender<LaunchEvent>, ) -> Result<Child, LaunchError>

Download the game and immediately launch it.

Equivalent to download_game followed by launch. Returns the tokio::process::Child handle so the caller can monitor or kill the process.

To receive a LaunchEvent::Close event, wait on the returned child and send it yourself:

let code = child.wait().await?.code().unwrap_or(-1);
let _ = tx.send(LaunchEvent::Close(code)).await;

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

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<U> for T
where U: From<T>,

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
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