// This file was generated by gir (https://github.com/gtk-rs/gir @ fe7a6ff+)
// from gir-files (https://github.com/gtk-rs/gir-files @ b215ee8)
// DO NOT EDIT

use FormatOptions;
use Header;
use ParserOptions;
use Stream;
use ffi;
use glib::object::IsA;
use glib::translate::*;
use glib_ffi;
use gobject_ffi;
use std::mem;
use std::ptr;

glib_wrapper! {
    /// A list of message or mime-part headers.
    ///
    /// # Implements
    ///
    /// [`HeaderListExt`](trait.HeaderListExt.html)
    pub struct HeaderList(Object<ffi::GMimeHeaderList, ffi::GMimeHeaderListClass>);

    match fn {
        get_type => || ffi::g_mime_header_list_get_type(),
    }
}

impl HeaderList {
    /// Creates a new `HeaderList` object.
    /// ## `options`
    /// a `ParserOptions` or `None`
    ///
    /// # Returns
    ///
    /// a new header list object.
    pub fn new<'a, P: Into<Option<&'a ParserOptions>>>(options: P) -> HeaderList {
        let options = options.into();
        unsafe {
            from_glib_full(ffi::g_mime_header_list_new(mut_override(options.to_glib_none().0)))
        }
    }
}

/// Trait containing all `HeaderList` methods.
///
/// # Implementors
///
/// [`HeaderList`](struct.HeaderList.html)
pub trait HeaderListExt {
    /// Appends a header. If `value` is `None`, a space will be set aside for it
    /// (useful for setting the order of headers before values can be
    /// obtained for them) otherwise the header will be unset.
    /// ## `name`
    /// header name
    /// ## `value`
    /// header value
    /// ## `charset`
    /// a charset
    fn append(&self, name: &str, value: &str, charset: &str);

    /// Removes all of the headers from the `HeaderList`.
    fn clear(&self);

    /// Checks whether or not a header exists.
    /// ## `name`
    /// header name
    ///
    /// # Returns
    ///
    /// `true` if the specified header exists or `false` otherwise.
    fn contains(&self, name: &str) -> bool;

    /// Gets the number of headers contained within the header list.
    ///
    /// # Returns
    ///
    /// the number of headers in the header list.
    fn get_count(&self) -> i32;

    /// Gets the first header with the specified name.
    /// ## `name`
    /// header name
    ///
    /// # Returns
    ///
    /// a `Header` for the specified `name`.
    fn get_header(&self, name: &str) -> Option<Header>;

    /// Gets the header at the specified `index` within the list.
    /// ## `index`
    /// the 0-based index of the header
    ///
    /// # Returns
    ///
    /// the header at position `index`.
    fn get_header_at(&self, index: i32) -> Option<Header>;

    /// Prepends a header. If `value` is `None`, a space will be set aside
    /// for it (useful for setting the order of headers before values can
    /// be obtained for them) otherwise the header will be unset.
    /// ## `name`
    /// header name
    /// ## `value`
    /// header value
    /// ## `charset`
    /// a charset
    fn prepend(&self, name: &str, value: &str, charset: &str);

    /// Remove the first instance of the specified header.
    /// ## `name`
    /// header name
    ///
    /// # Returns
    ///
    /// `true` if the header was successfully removed or `false` if
    /// the specified header could not be found.
    fn remove(&self, name: &str) -> bool;

    /// Removes the header at the specified `index` from `self`.
    /// ## `index`
    /// the 0-based index of the header to remove
    fn remove_at(&self, index: i32);

    /// Set the value of the specified header. If `value` is `None` and the
    /// header, `name`, had not been previously set, a space will be set
    /// aside for it (useful for setting the order of headers before values
    /// can be obtained for them) otherwise the header will be unset.
    ///
    /// Note: If there are multiple headers with the specified field name,
    /// the first instance of the header will be replaced and further
    /// instances will be removed.
    /// ## `name`
    /// header name
    /// ## `value`
    /// header value
    /// ## `charset`
    /// a charset
    fn set(&self, name: &str, value: &str, charset: &str);

    /// Allocates a string buffer containing the raw rfc822 headers
    /// contained in `self`.
    /// ## `options`
    /// a `FormatOptions` or `None`
    ///
    /// # Returns
    ///
    /// a string containing the header block.
    fn to_string<'a, P: Into<Option<&'a FormatOptions>>>(&self, options: P) -> String;

    /// Write the headers to a stream.
    /// ## `options`
    /// a `FormatOptions` or `None`
    /// ## `stream`
    /// output stream
    ///
    /// # Returns
    ///
    /// the number of bytes written or %-1 on fail.
    fn write_to_stream<'a, P: Into<Option<&'a FormatOptions>>, Q: IsA<Stream>>(&self, options: P, stream: &Q) -> isize;
}

impl<O: IsA<HeaderList>> HeaderListExt for O {
    fn append(&self, name: &str, value: &str, charset: &str) {
        unsafe {
            ffi::g_mime_header_list_append(self.to_glib_none().0, name.to_glib_none().0, value.to_glib_none().0, charset.to_glib_none().0);
        }
    }

    fn clear(&self) {
        unsafe {
            ffi::g_mime_header_list_clear(self.to_glib_none().0);
        }
    }

    fn contains(&self, name: &str) -> bool {
        unsafe {
            from_glib(ffi::g_mime_header_list_contains(self.to_glib_none().0, name.to_glib_none().0))
        }
    }

    fn get_count(&self) -> i32 {
        unsafe {
            ffi::g_mime_header_list_get_count(self.to_glib_none().0)
        }
    }

    fn get_header(&self, name: &str) -> Option<Header> {
        unsafe {
            from_glib_none(ffi::g_mime_header_list_get_header(self.to_glib_none().0, name.to_glib_none().0))
        }
    }

    fn get_header_at(&self, index: i32) -> Option<Header> {
        unsafe {
            from_glib_none(ffi::g_mime_header_list_get_header_at(self.to_glib_none().0, index))
        }
    }

    fn prepend(&self, name: &str, value: &str, charset: &str) {
        unsafe {
            ffi::g_mime_header_list_prepend(self.to_glib_none().0, name.to_glib_none().0, value.to_glib_none().0, charset.to_glib_none().0);
        }
    }

    fn remove(&self, name: &str) -> bool {
        unsafe {
            from_glib(ffi::g_mime_header_list_remove(self.to_glib_none().0, name.to_glib_none().0))
        }
    }

    fn remove_at(&self, index: i32) {
        unsafe {
            ffi::g_mime_header_list_remove_at(self.to_glib_none().0, index);
        }
    }

    fn set(&self, name: &str, value: &str, charset: &str) {
        unsafe {
            ffi::g_mime_header_list_set(self.to_glib_none().0, name.to_glib_none().0, value.to_glib_none().0, charset.to_glib_none().0);
        }
    }

    fn to_string<'a, P: Into<Option<&'a FormatOptions>>>(&self, options: P) -> String {
        let options = options.into();
        unsafe {
            from_glib_full(ffi::g_mime_header_list_to_string(self.to_glib_none().0, mut_override(options.to_glib_none().0)))
        }
    }

    fn write_to_stream<'a, P: Into<Option<&'a FormatOptions>>, Q: IsA<Stream>>(&self, options: P, stream: &Q) -> isize {
        let options = options.into();
        unsafe {
            ffi::g_mime_header_list_write_to_stream(self.to_glib_none().0, mut_override(options.to_glib_none().0), stream.to_glib_none().0)
        }
    }
}