Mi Primera Biblioteca de Rust
Una biblioteca de ejemplo que demuestra las capacidades básicas de Rust, incluyendo funciones matemáticas y utilidades de texto.
Características
- Funciones matemáticas: Suma, multiplicación, factorial y verificación de números primos
- Utilidades de texto: Inversión de cadenas y conteo de palabras
- Documentación completa: Cada función incluye ejemplos de uso
- Tests exhaustivos: Cobertura completa de todas las funcionalidades
Instalación
Para usar esta biblioteca en tu proyecto Rust, agrega la siguiente dependencia a tu Cargo.toml:
[]
= "0.1.0"
Uso
Funciones matemáticas
use ;
// Suma de dos números
let resultado = add; // 8
// Multiplicación
let producto = multiply; // 24
// Factorial
let fact = factorial; // 120
// Verificar si es primo
let es_primo = is_prime; // true
Utilidades de texto
use ;
// Invertir cadena
let invertida = reverse_string; // "aloh"
// Contar palabras
let palabras = word_count; // 3
Funciones disponibles
| Función | Descripción | Ejemplo |
|---|---|---|
add(a, b) |
Suma dos números | add(2, 3) = 5 |
multiply(a, b) |
Multiplica dos números | multiply(4, 5) = 20 |
factorial(n) |
Calcula el factorial | factorial(5) = 120 |
is_prime(n) |
Verifica si es primo | is_prime(17) = true |
reverse_string(s) |
Invierte una cadena | reverse_string("hola") = "aloh" |
word_count(s) |
Cuenta palabras | word_count("hola mundo") = 2 |
Desarrollo
Requisitos
- Rust 1.70.0 o superior
- Cargo (incluido con Rust)
Compilar
Ejecutar tests
Generar documentación
Ejecutar clippy (linter)
Estructura del proyecto
mi_primera_lib/
├── Cargo.toml # Configuración del proyecto
├── README.md # Este archivo
└── src/
└── lib.rs # Código fuente de la biblioteca
Contribuir
- Fork el proyecto
- Crea una rama para tu feature (
git checkout -b feature/AmazingFeature) - Commit tus cambios (
git commit -m 'Add some AmazingFeature') - Push a la rama (
git push origin feature/AmazingFeature) - Abre un Pull Request
Licencia
Este proyecto está bajo la Licencia MIT. Ver el archivo LICENSE para más detalles.
Autor
Jenny Tejedor - tu.email@ejemplo.com
Agradecimientos
- Comunidad de Rust por su excelente documentación
- Cargo por hacer la gestión de dependencias tan sencilla
- Todos los contribuidores que ayudan a mejorar este proyecto
¡Disfruta programando en Rust! 🦀