pub struct Server {
pub port: u16,
pub addr: String,
pub started: bool,
pub serve: String,
pub interval: u64,
pub secret: Option<String>,
/* private fields */
}
Expand description
A websocket server for Voxelize, holds all worlds data, and runs as a background system service.
Fields
port: u16
The port that this voxelize server is running on.
addr: String
The address that this voxelize server is running on.
started: bool
Whether or not if the socket server has started as a system service.
serve: String
Static folder to serve from.
interval: u64
Interval to tick the server at.
secret: Option<String>
A secret to join the server.
Implementations
sourceimpl Server
impl Server
sourcepub fn new() -> ServerBuilder
pub fn new() -> ServerBuilder
Create a new Voxelize server instance used to host all the worlds.
Example
// Create a server of port 4000 on "0.0.0.0"
let server = Server::new().addr("0.0.0.0").port(4000).build();
// Run the server on Voxelize
Voxelize::run(server);
sourcepub fn add_world(&mut self, world: World) -> Result<&mut World, AddWorldError>
pub fn add_world(&mut self, world: World) -> Result<&mut World, AddWorldError>
Add a world instance to the server. Different worlds have different configurations, and can hold their own set of clients within. If the server has already started, the added world will be started right away.
sourcepub fn create_world(
&mut self,
name: &str,
config: &WorldConfig
) -> Result<&mut World, AddWorldError>
pub fn create_world(
&mut self,
name: &str,
config: &WorldConfig
) -> Result<&mut World, AddWorldError>
Create a world in the server. Different worlds have different configurations, and can hold their own set of clients within. If the server has already started, the added world will be started right away.
sourcepub fn get_world_mut(&mut self, world_name: &str) -> Option<&mut World>
pub fn get_world_mut(&mut self, world_name: &str) -> Option<&mut World>
Get a mutable world reference by name.
Trait Implementations
sourceimpl Actor for Server
impl Actor for Server
Make actor from ChatServer
type Context = Context<Server>
type Context = Context<Server>
We are going to use simple Context, we just need ability to communicate with other actors.
sourcefn started(&mut self, ctx: &mut Self::Context)
fn started(&mut self, ctx: &mut Self::Context)
Called when an actor gets polled the first time.
sourcefn stopping(&mut self, ctx: &mut Self::Context) -> Running
fn stopping(&mut self, ctx: &mut Self::Context) -> Running
Called after an actor is in Actor::Stopping
state. Read more
sourcefn start(self) -> Addr<Self> where
Self: Actor<Context = Context<Self>>,
fn start(self) -> Addr<Self> where
Self: Actor<Context = Context<Self>>,
Start a new asynchronous actor, returning its address. Read more
sourcefn start_default() -> Addr<Self> where
Self: Actor<Context = Context<Self>> + Default,
fn start_default() -> Addr<Self> where
Self: Actor<Context = Context<Self>> + Default,
Construct and start a new asynchronous actor, returning its address. Read more
sourceimpl Handler<ClientMessage> for Server
impl Handler<ClientMessage> for Server
Handler for Message message.
Auto Trait Implementations
impl !RefUnwindSafe for Server
impl Send for Server
impl Sync for Server
impl Unpin for Server
impl !UnwindSafe for Server
Blanket Implementations
impl<T> Any for T where
T: Any,
impl<T> Any for T where
T: Any,
fn get_type_id(&self) -> TypeId
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more