pub struct Credential { /* private fields */ }Expand description
API credentials required for signing Bybit REST requests.
Implementations§
Source§impl Credential
impl Credential
Sourcepub fn resolve(
api_key: Option<String>,
api_secret: Option<String>,
environment: BybitEnvironment,
) -> Option<Self>
pub fn resolve( api_key: Option<String>, api_secret: Option<String>, environment: BybitEnvironment, ) -> Option<Self>
Resolves credentials from provided values or environment variables.
If both api_key and api_secret are provided, uses those.
Otherwise falls back to environment variables based on the environment.
Sourcepub fn new(api_key: impl Into<String>, api_secret: impl Into<String>) -> Self
pub fn new(api_key: impl Into<String>, api_secret: impl Into<String>) -> Self
Creates a new Credential instance from the API key and secret.
Sourcepub fn api_key_masked(&self) -> String
pub fn api_key_masked(&self) -> String
Returns a masked version of the API key for logging purposes.
Shows first 4 and last 4 characters with ellipsis in between. For keys shorter than 8 characters, shows asterisks only.
Sourcepub fn sign_websocket_auth(&self, expires: i64) -> String
pub fn sign_websocket_auth(&self, expires: i64) -> String
Produces the Bybit WebSocket authentication signature for the provided expiry timestamp.
expires should be the millisecond timestamp used by the login payload.
Sourcepub fn sign_with_payload(
&self,
timestamp: &str,
recv_window_ms: u64,
payload: Option<&str>,
) -> String
pub fn sign_with_payload( &self, timestamp: &str, recv_window_ms: u64, payload: Option<&str>, ) -> String
Produces the Bybit HMAC signature for the provided payload.
payload should contain either a URL-encoded query string (for GET requests)
or a JSON body (for POST requests). Callers are responsible for ensuring that
the encoding matches the bytes sent over the wire.
Trait Implementations§
Source§impl Clone for Credential
impl Clone for Credential
Source§fn clone(&self) -> Credential
fn clone(&self) -> Credential
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for Credential
impl Debug for Credential
Auto Trait Implementations§
impl Freeze for Credential
impl RefUnwindSafe for Credential
impl Send for Credential
impl Sync for Credential
impl Unpin for Credential
impl UnsafeUnpin for Credential
impl UnwindSafe for Credential
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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 more