whiteoutlib 0.1.4

Read and write Blizzard game assets from Rust: models (MDX, M2, M3), textures (BLP, DDS, PNG, JPEG, BMP, TGA, TIFF, GIF) and archives (CASC, MPQ).
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
60
61
62
63
64
65
66
67
68

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow
/// @file cache_traits.h
/// @brief Cache policy traits for StorageBackendImpl.
///
/// MemCacheEnabled wraps MemoryCache; NoCachePolicy compiles to no-ops.
/// Internal header — not part of the public include path.
#pragma once

#include "../cdn/memory_cache.h"

#include <array>
#include <memory>
#include <optional>
#include <vector>

namespace whiteout::storages::casc {

/// Cache trait that wraps a MemoryCache instance.
/// All methods forward to the underlying cache.
struct MemCacheEnabled {
    mutable std::unique_ptr<MemoryCache> cache;

    explicit MemCacheEnabled(std::unique_ptr<MemoryCache> c) : cache(std::move(c)) {}

    MemCacheEnabled(MemCacheEnabled&&) = default;
    MemCacheEnabled& operator=(MemCacheEnabled&&) = default;

    static constexpr bool hasCache() noexcept {
        return true;
    }

    std::optional<std::vector<u8>> get(const std::array<u8, 16>& key) const {
        return cache->get(key);
    }

    std::optional<MemoryCache::CacheView> view(const std::array<u8, 16>& key) const {
        return cache->view(key);
    }

    void put(const std::array<u8, 16>& key, const std::vector<u8>& data) const {
        cache->put(key, data);
    }

    void flush() const {
        cache->clear();
    }
};

/// No-op cache trait.  All methods compile to nothing.
struct NoCachePolicy {
    static constexpr bool hasCache() noexcept {
        return false;
    }

    std::optional<std::vector<u8>> get(const std::array<u8, 16>&) const {
        return std::nullopt;
    }

    std::optional<MemoryCache::CacheView> view(const std::array<u8, 16>&) const {
        return std::nullopt;
    }

    void put(const std::array<u8, 16>&, const std::vector<u8>&) const {}
    void flush() const {}
};

} // namespace whiteout::storages::casc