pub struct Users { /* private fields */ }
Expand description
The Users
struct is used to query users from the database, as well as to create, modify and delete them.
Implementations§
Source§impl Users
impl Users
Sourcepub async fn open_sqlite(path: &str) -> Result<Self, Error>
pub async fn open_sqlite(path: &str) -> Result<Self, Error>
It creates a Users
instance by connecting it to a sqlite database.
This method uses the sqlx
crate.
If the database does not yet exist it will return an Error. By default,
sessions will be stored on a concurrent HashMap. In order to have persistent sessions see
the method open_redis
.
let users = Users::open_sqlite("database.db").await?;
rocket::build()
.manage(users)
.launch()
.await;
Sourcepub async fn create_table(&self) -> Result<(), Error>
pub async fn create_table(&self) -> Result<(), Error>
Initializes the user table in the database. It won’t drop the table if it already exists.
It is necessary to call it explicitly when casting the Users
struct from an already
established database connection and if the table hasn’t been created yet. If the table
already exists then this step is not necessary.
let mut conn = SqlitePool::connect("database.db").await?;
let mut users: Users = conn.into();
users.open_redis("redis://127.0.0.1/")?;
users.create_table().await?;
Sourcepub fn open_redis(&mut self, path: impl IntoConnectionInfo) -> Result<(), Error>
pub fn open_redis(&mut self, path: impl IntoConnectionInfo) -> Result<(), Error>
Opens a redis connection. It allows for sessions to be stored persistently across
different launches. Note that persistent sessions also require a secret_key
to be set in the Rocket.toml configuration file.
let mut users = Users::open_sqlite("database.db").await?;
users.open_redis("redis://127.0.0.1/")?;
rocket::build()
.manage(users)
.launch();
Sourcepub fn open_rusqlite(path: impl AsRef<Path>) -> Result<Self, Error>
pub fn open_rusqlite(path: impl AsRef<Path>) -> Result<Self, Error>
It creates a Users
instance by connecting it to a sqlite database.
This method uses the rusqlite
crate.
If the database does not yet exist it will attempt to create it. By default,
sessions will be stored on a concurrent HashMap. In order to have persistent sessions see
the method open_redis
.
let users = Users::open_rusqlite("database.db")?;
rocket::build()
.manage(users)
.launch()
.await;
Sourcepub async fn open_postgres(path: &str) -> Result<Self, Error>
pub async fn open_postgres(path: &str) -> Result<Self, Error>
It creates a Users
instance by connecting it to a postgres database.
This method uses the sqlx
crate.
let users = Users::open_postgres("postgres://postgres:password@localhost/test").await?;
rocket::build()
.manage(users)
.launch();
Sourcepub async fn open_mysql(path: &str) -> Result<Self, Error>
pub async fn open_mysql(path: &str) -> Result<Self, Error>
It creates a Users
instance by connecting it to a mysql database.
This method uses the sqlx
crate.
let users = Users::open_mysql(DATABASE_URL).await?;
rocket::build()
.manage(users)
.launch();
Sourcepub async fn get_by_email(&self, email: &str) -> Result<User, Error>
pub async fn get_by_email(&self, email: &str) -> Result<User, Error>
It queries a user by their email.
#[get("/user-information/<email>")]
async fn user_information(email: String, users: &State<Users>) -> Result<String, Error> {
let user = users.get_by_email(&email).await?;
Ok(format!("{:?}", user))
}
Sourcepub async fn get_by_id(&self, user_id: i32) -> Result<User, Error>
pub async fn get_by_id(&self, user_id: i32) -> Result<User, Error>
It queries a user by their email.
let user = users.get_by_id(3).await?;
format!("{:?}", user);
Sourcepub async fn create_user(
&self,
email: &str,
password: &str,
is_admin: bool,
) -> Result<(), Error>
pub async fn create_user( &self, email: &str, password: &str, is_admin: bool, ) -> Result<(), Error>
Inserts a new user in the database. It will fail if the user already exists.
#[get("/create_admin/<email>/<password>")]
async fn create_admin(email: String, password: String, users: &State<Users>) -> Result<String, Error> {
users.create_user(&email, &password, true).await?;
Ok("User created successfully".into())
}
Sourcepub async fn delete(&self, id: i32) -> Result<(), Error>
pub async fn delete(&self, id: i32) -> Result<(), Error>
Deletes a user from de database. Note that this method won’t delete the session.
To do that use Auth::delete
.
#[get("/delete_user/<id>")]
async fn delete_user(id: i32, users: &State<Users>) -> Result<String> {
users.delete(id).await?;
Ok("The user has been deleted.")
}
Trait Implementations§
Source§impl<T0: 'static + DBConnection, T1: 'static + SessionManager> From<(T0, T1)> for Users
Additionally, Users
can be created from a tuple,
where the first element is a database connection, and the second is a redis connection.
impl<T0: 'static + DBConnection, T1: 'static + SessionManager> From<(T0, T1)> for Users
Additionally, Users
can be created from a tuple,
where the first element is a database connection, and the second is a redis connection.
let (db_client, connection) = tokio_postgres::connect(postgres_path, NoTls).await?;
let redis_client = redis::Client::open(redis_path)?;
let users: Users = (db_client, redis_client).into();
// we create the user table in the
// database if it does not exists.
users.create_table();
Source§impl<Conn: 'static + DBConnection> From<Conn> for Users
A Users
instance can also be created from a database connection.
impl<Conn: 'static + DBConnection> From<Conn> for Users
A Users
instance can also be created from a database connection.
let (client, connection) = tokio_postgres::connect("host=localhost user=postgres", NoTls).await?;
let users: Users = client.into();
// we create the user table in the
// database if it does not exists.
users.create_table();
Auto Trait Implementations§
impl Freeze for Users
impl !RefUnwindSafe for Users
impl Send for Users
impl Sync for Users
impl Unpin for Users
impl !UnwindSafe for Users
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);