code-style

Code Style & Conventions

Rust Edition & Version

• Edition: 2024
• MSRV: 1.85
• All code must compile on stable Rust

Naming Conventions

• Follow Skia's naming where possible for API compatibility
• Use snake_case for functions and variables
• Use PascalCase for types and traits
• Prefix internal/private items with underscore only when necessary
• Crate names: skia-rs-{module} (hyphenated)
• Module imports: skia_rs_{module} (underscored)

Type Aliases

// Core type alias - matches Skia's SkScalar
pub type Scalar = f32;

Documentation

• All public items MUST have doc comments
• Use //! for module-level documentation
• Include examples in doc comments for complex APIs
• Reference corresponding Skia types/functions in docs

/// A 2D point with floating-point coordinates.
///
/// Corresponds to Skia's `SkPoint`.
///
/// # Examples
/// ```
/// use skia_rs_core::Point;
/// let p = Point::new(10.0, 20.0);
/// assert_eq!(p.length(), (500.0_f32).sqrt());
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Default)]
#[repr(C)]
pub struct Point {
    pub x: Scalar,
    pub y: Scalar,
}

Error Handling

• Use thiserror for error types
• Prefer Option<T> over Result<T, E> for simple failure cases (matching Skia patterns)
• Never panic in library code except for invariant violations
• Use debug_assert! for development-time checks

Memory & Performance

• Use #[repr(C)] for FFI-compatible structs
• Derive bytemuck::{Pod, Zeroable} for types that need zero-copy operations
• Use SmallVec for small, stack-allocated collections
• Prefer &self over &mut self where possible
• Avoid allocations in hot paths

use bytemuck::{Pod, Zeroable};

#[derive(Debug, Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct Color(pub u32);

Inline Hints

• Use #[inline] for small, frequently-called methods
• Use #[inline(always)] sparingly, only for critical hot paths
• Let the compiler decide for complex functions