Page Menu
Home
DevCentral
Search
Configure Global Search
Log In
Files
F24682644
config.rs
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Flag For Later
Size
2 KB
Referenced Files
None
Subscribers
None
config.rs
View Options
//! This module allows to configure the API.
//!
//! It provides a Config trait to build custom configuration implementation.
//!
//! It also provides a `DefaultConfig` implementation of this `Config` trait to
//! extract variables from an .env file or environment.
use
dotenv
::
dotenv
;
use
std
::
env
;
use
std
::
error
::
Error
;
use
ErrorResult
;
/* -------------------------------------------------------------
Config trait
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
/// This trait allows to provide a configuration for the resources needed by the API.
pub
trait
Config
{
fn
get_database_url
(
&
self
)
->
&
str
;
fn
get_entry_point
(
&
self
)
->
&
str
;
fn
get_database_pool_size
(
&
self
)
->
u32
;
}
/* -------------------------------------------------------------
DefaultConfig
:: Config
:: sui generis implementation
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
/// This is a default implementation of the `Config` trait, which extracts the following variables
/// from an .env file or environment:
///
/// - `API_ENTRY_POINT` (facultative, by default `/`): the mouting point of the API methods
/// - `DATABASE_URL` (mandatory): the URL to connect to your database
/// - `DATABASE_POOL_SIZE` (facultative, by default 4): the number of connections to open
pub
struct
DefaultConfig
{
database_url
:
String
,
entry_point
:
String
,
database_pool_size
:
u32
,
}
impl
Config
for
DefaultConfig
{
fn
get_database_url
(
&
self
)
->
&
str
{
&
self
.
database_url
}
fn
get_entry_point
(
&
self
)
->
&
str
{
&
self
.
entry_point
}
fn
get_database_pool_size
(
&
self
)
->
u32
{
self
.
database_pool_size
}
}
impl
DefaultConfig
{
pub
const
DEFAULT_DATABASE_POOL_SIZE
:
u32
=
4
;
pub
fn
parse_environment
()
->
ErrorResult
<
Self
>
{
if
let
Err
(
error
)
=
dotenv
()
{
warn
!
(
target
:
"config"
,
"Can't parse .env: {}"
,
error
.
description
());
};
let
database_url
=
match
env
::
var
(
"DATABASE_URL"
)
{
Ok
(
url
)
=>
url
,
Err
(
e
)
=>
{
error
!
(
target
:
"config"
,
"You need to specify a DATABASE_URL variable in the environment (or .env file)."
);
return
Err
(
Box
::
new
(
e
));
}
};
let
entry_point
=
env
::
var
(
"API_ENTRY_POINT"
).
unwrap_or
(
String
::
from
(
"/"
));
let
database_pool_size
=
match
env
::
var
(
"DATABASE_POOL_SIZE"
)
{
Ok
(
variable
)
=>
{
match
variable
.
parse
::
<
u32
>
()
{
Ok
(
size
)
=>
size
,
Err
(
_
)
=>
{
warn
!
(
target
:
"config"
,
"The DATABASE_POOL_SIZE variable must be an unsigned integer."
);
DefaultConfig
::
DEFAULT_DATABASE_POOL_SIZE
},
}
},
Err
(
_
)
=>
DefaultConfig
::
DEFAULT_DATABASE_POOL_SIZE
,
};
Ok
(
DefaultConfig
{
database_url
,
entry_point
,
database_pool_size
,
})
}
}
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Sat, Mar 7, 01:40 (6 h, 48 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3474996
Default Alt Text
config.rs (2 KB)
Attached To
Mode
rLF Limiting Factor
Attached
Detach File
Event Timeline
Log In to Comment