primer3 0.1.0

Safe Rust bindings to the primer3 primer design library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

//! Thermodynamic parameter initialization.
//!
//! The primer3 C library stores thermodynamic parameters (NN stacking energies,
//! loop penalties, etc.) in global static arrays. These are compiled in from
//! `thal_default_params.h` and initialized at program load time.
//!
//! This module provides `ensure_initialized()` which is currently a no-op since
//! the parameters are compiled in. It exists as a hook in case future versions
//! need explicit initialization (e.g., loading custom parameter files).

use crate::error::Result;

/// Ensures thermodynamic parameters are ready for use.
///
/// This is called automatically by all public calculation functions.
/// It is safe to call multiple times. Currently a no-op since the default
/// thermodynamic parameters are compiled into the C library via
/// `thal_default_params.h`.
///
/// # Errors
///
/// Currently always returns `Ok(())`. Future versions may return an error
/// if parameter loading fails.
#[inline]
#[allow(clippy::unnecessary_wraps)]
pub(crate) fn ensure_initialized() -> Result<()> {
    Ok(())
}