quick_example

Function quick_example 

Source
pub fn quick_example()
Expand description

Quick example demonstrating basic library usage

This function provides a simple demonstration of core library functionality including classical ciphers and modern hash functions. It exists primarily to ensure documentation examples compile correctly.

§Examples

The following example shows basic usage patterns:

use ruscrypt::{classical::caesar, hash::sha256};

// Classical cipher encryption/decryption
let encrypted = caesar::encrypt("Hello", 3).unwrap();
let decrypted = caesar::decrypt(&encrypted, 3).unwrap();
assert_eq!(decrypted, "Hello");

// Modern hash function
let hash = sha256::hash("test").unwrap();
assert_eq!(hash.len(), 64); // SHA-256 produces 64 hex characters

§Note

This function exists to validate documentation examples and does not perform any actual operations when called.