Skip to content

Commit

Permalink
docs: Add annotation docs to strip_suffix_treated
Browse files Browse the repository at this point in the history
  • Loading branch information
bush1D3v committed Sep 7, 2024
1 parent 224bc16 commit b103f8c
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions src/shared/treaties/strip_suffix_treated.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,36 @@
use crate::shared::exceptions::exception::Exception;
use actix_web::HttpResponse;

/// # Strip Suffix
///
/// ## Purpose
///
/// Strip suffix the salt from a user_password
///
/// ## Arguments
///
/// * `input` - String
/// * `suffix` - String
///
/// ## Returns
///
/// String
///
/// ## Errors
///
/// - Internal Server Error - If it fails to strip the suffix
///
/// ## Example
///
/// ```rust
/// use actix_web::HttpResponse;
/// use navarro_blog_api::shared::treaties::strip_suffix_treated::StripSuffix;
///
/// let password = String::from("test12856464656454545");
/// let salt = "12856464656454545";
///
/// let response = StripSuffix::strip_suffix(password, salt);
/// ```
pub struct StripSuffix {}

impl StripSuffix {
Expand Down

0 comments on commit b103f8c

Please sign in to comment.