lib.h File Reference

API for the header cache compression. More...

#include <stdlib.h>

Include dependency graph for lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ComprOps

Typedefs
typedef void	ComprHandle
	Opaque type for compression data.

Functions
const struct ComprOps *	compress_get_ops (const char *compr)
	Get the API functions for a compress backend.
const char *	compress_list (void)
	Get a list of compression backend names.

Variables
const struct ComprOps	compr_lz4_ops
const struct ComprOps	compr_zlib_ops
const struct ComprOps	compr_zstd_ops

Detailed Description

API for the header cache compression.

Authors

• Tino Reichardt
• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file lib.h.

Typedef Documentation

ComprHandle

typedef void ComprHandle

Opaque type for compression data.

Definition at line 56 of file lib.h.

Function Documentation

compress_get_ops()

const struct ComprOps * compress_get_ops

(

const char *

compr

)

Get the API functions for a compress backend.

Parameters

compr

Name of the backend

Return values

ptr	Set of function pointers

Definition at line 81 of file compress.c.

{
  const struct ComprOps **compr_ops = CompressOps;
 
  if (!compr || !*compr)
    return *compr_ops;
 
  for (; *compr_ops; compr_ops++)
  {
    if (mutt_str_equal(compr, (*compr_ops)->name))
      break;
  }
 
  return *compr_ops;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compress_list()

const char * compress_list

(

void

)

Get a list of compression backend names.

Return values

ptr	Comma-space-separated list of names

Note

The caller should free the string

Definition at line 58 of file compress.c.

{
  char tmp[256] = { 0 };
  const struct ComprOps **compr_ops = CompressOps;
  size_t len = 0;
 
  for (; *compr_ops; compr_ops++)
  {
    if (len != 0)
    {
      len += snprintf(tmp + len, sizeof(tmp) - len, ", ");
    }
    len += snprintf(tmp + len, sizeof(tmp) - len, "%s", (*compr_ops)->name);
  }
 
  return mutt_str_dup(tmp);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

compr_lz4_ops

const struct ComprOps compr_lz4_ops

extern

compr_zlib_ops

const struct ComprOps compr_zlib_ops

extern

compr_zstd_ops

const struct ComprOps compr_zstd_ops

extern