Struct db::cache_structures::socket::CacheSocket

pub struct CacheSocket {
    pub uid: UID,
    pub ip: String,
    pub port: u16,
    // some fields omitted
}

Template structure to for raw socket information

Fields

uid: UID

unique id of socket

ip: String

ip address of where socket is coming form

port: u16

port of where socket is coming from

Methods

impl<'a> CacheSocket

pub fn new_with_uid(uid: UID) -> Self

create instance of socket with supplied UID

pub fn new() -> Self

create blank instance of Socket

pub fn set_address(&mut self, addr: &SocketAddr) -> &mut Self

set ip and port for this struct with a supplied std::net::SocketAddr

pub fn set_ip(&mut self, ip: &'a str) -> &mut Self

set ip for this struct

pub fn set_port(&mut self, port: u16) -> &mut Self

set port for this struct

pub fn set_value<F: ToRedisArgs + ToString, V: ToRedisArgs + ToString>(
    &mut self,
    field: F,
    value: V
) -> RedisResult<()>

set key and value

pub fn get_value<T: FromStr + Debug>(
    &mut self,
    field_name: &'a str
) -> Option<T> where
    T::Err: Debug, 

retrieve a value from field of struct, if it does not exist, will return None

Trait Implementations

impl Cachable for CacheSocket

fn dump(&mut self) -> RedisResult<()>

construct hmap of current object that inherits this trait

fn load(self) -> RedisResult<Self>

decontructs data from caching server and updates internal fields must not lose track of UID

fn destruct(self) -> RedisResult<()>

Permentatly removes all data associated to this object from redis server

fn uid(&self) -> UID

retrieve UID for object

fn name(&self) -> &str

retrieve name of object

fn make_key<'a>(&self, field_name: &'a str) -> String

create key from struct name, uid, and custom identifier

fn create_tag<'a, T: ToRedisArgs + ToString>(
    &self,
    field_name: &'a str,
    field_value: &'a T
) -> (String, String)

Create tag for redis consumption in the format of (Name:uid:field, value)