Skip to main content

Env

Struct Env 

Source
pub struct Env { /* private fields */ }
Expand description

环境变量管理器 — 对齐 PHP think\facade\Env

通过 .env 文件加载配置,同时支持读取真实进程环境变量。

§优先级

get() 查找顺序:

  1. 真实进程环境变量 std::env::var(name)
  2. 内部存储(.env 文件加载或 set() 写入的值)

§线程安全

内部存储通过 Arc<RwLock<HashMap>> 保护,支持并发读、互斥写。 不调用 std::env::set_var,避免 Rust 2024 edition 的线程安全警告。

§PHP 对齐

// PHP think\facade\Env
Env::load('.env');          // 加载 .env 文件
Env::set('APP_KEY', 'xxx'); // 设置内部变量
Env::get('APP_KEY');        // 获取(优先真实环境变量)
Env::has('APP_KEY');        // 检查存在

Implementations§

Source§

impl Env

Source

pub fn new() -> Env

创建空的 Env 实例

Source

pub async fn load_from_file( &self, path: impl AsRef<Path>, ) -> Result<(), EnvError>

.env 文件加载配置

支持 INI 风格的 [section] 段,section 内的键会以 section.key 形式存储。

§参数
  • path: .env 文件路径
§返回

成功返回 Ok(()),失败返回 EnvError

§PHP 对齐
Env::load('.env');
§错误
Source

pub fn get(&self, name: &str) -> Option<String>

获取环境变量值

§优先级
  1. 真实进程环境变量 std::env::var(name)
  2. 内部存储(.env 文件加载或 set() 写入的值)
§参数
  • name: 环境变量名(支持点分隔,如 database.hostname
§返回

存在返回 Some(value),不存在返回 None

§PHP 对齐
Env::get('APP_KEY');  // 无默认值,不存在返回 null
Source

pub fn get_with_default(&self, name: &str, default: &str) -> String

获取环境变量值,不存在时返回默认值

§参数
  • name: 环境变量名
  • default: 默认值
§返回

存在返回实际值,不存在返回 default

§PHP 对齐
Env::get('APP_DEBUG', false);  // 不存在时返回 false
Source

pub fn has(&self, name: &str) -> bool

检查环境变量是否存在

§优先级

Env::get:真实进程环境变量优先于内部存储。

§参数
  • name: 环境变量名
§返回

存在返回 true,否则返回 false

§PHP 对齐
Env::has('APP_KEY');
Source

pub fn set(&self, name: &str, value: &str)

设置环境变量(仅写入内部存储)

§注意

本方法不调用 std::env::set_var,仅修改内部 HashMap。 这样做的原因:

  1. 避免 Rust 2024 edition 中 set_var 的线程安全警告
  2. 对齐 PHP think\facade\Env::set() 的行为(仅修改内部数组,不调用 putenv()
§参数
  • name: 环境变量名
  • value: 环境变量值
§PHP 对齐
Env::set('APP_KEY', 'base64:xxxxxx');
Source

pub fn remove(&self, name: &str) -> bool

删除内部存储中的环境变量

§注意

本方法仅删除内部存储中的值,不影响真实进程环境变量。

§参数
  • name: 环境变量名
§返回

如果内部存储中存在该键并已删除,返回 true;否则返回 false

Source

pub fn all(&self) -> HashMap<String, String>

获取内部存储的所有键值对(快照)

§注意

返回的是内部存储的副本,不包含真实进程环境变量。 主要用于调试和测试。

§返回

所有内部存储键值对的 HashMap

Source

pub fn clear(&self)

清空内部存储

§注意

仅清空内部存储,不影响真实进程环境变量。

Trait Implementations§

Source§

impl Clone for Env

Source§

fn clone(&self) -> Env

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Env

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Default for Env

Source§

fn default() -> Env

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Env

§

impl !UnwindSafe for Env

§

impl Freeze for Env

§

impl Send for Env

§

impl Sync for Env

§

impl Unpin for Env

§

impl UnsafeUnpin for Env

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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