goldforge 0.8.1

Library for handling file formats used by GoldSrc and related engines.
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

// Copyright 2025-2026 Gabriel Bjørnager Jensen.
//
// This Source Code Form is subject to the terms of
// the Mozilla Public License, v. 2.0. If a copy of
// the MPL was not distributed with this file, you
// can obtain one at:
// <https://mozilla.org/MPL/2.0/>.

//! The [`Compression`] type.

use crate::wad::ffi::quake;

use core::num::NonZero;

/// A compression format.
#[repr(transparent)]
#[derive(
	Clone,
	Copy,
	Debug,
	Eq,
	PartialEq,
)]
pub struct Compression(NonZero<i8>);

impl Compression {
	/// Quake's LZSS format.
	pub const LZSS: Self = Self::from_i8(quake::CMP_LZSS).unwrap();

	/// Constructs a compression from an [`i8`] value.
	///
	/// If the provided value is zero, this function
	/// will always return [`None`].
	#[inline(always)]
	#[must_use]
	pub const fn from_i8(value: i8) -> Option<Self> {
		match NonZero::new(value) {
			Some(value) => Some(Self(value)),
			_           => None,
		}
	}

	/// Interprets the compression format as an [`i8`]
	/// value.
	///
	/// This value is guaranteed to never be zero.
	#[inline(always)]
	#[must_use]
	pub const fn to_i8(self) -> i8 {
		self.0.get()
	}
}

impl From<Compression> for i8 {
	#[inline(always)]
	fn from(value: Compression) -> Self {
		value.to_i8()
	}
}