.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTTP::Headers::ActionPack::MediaType 3pm"
.TH HTTP::Headers::ActionPack::MediaType 3pm 2024-03-06 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
HTTP::Headers::ActionPack::MediaType \- A Media Type
.SH VERSION
.IX Header "VERSION"
version 0.09
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use HTTP::Headers::ActionPack::MediaType;
\&
\&  # normal constructor
\&  my $mt = HTTP::Headers::ActionPack::MediaType\->new(
\&      \*(Aqapplication/xml\*(Aq => (
\&          \*(Aqq\*(Aq       => 0.5,
\&          \*(Aqcharset\*(Aq => \*(AqUTF\-8\*(Aq
\&      )
\&  );
\&
\&  # construct from string
\&  my $mt = HTTP::Headers::ActionPack::MediaType\->new_from_string(
\&      \*(Aqapplication/xml; q=0.5; charset=UTF\-8\*(Aq
\&  );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is an object which represents an HTTP media type
definition. This is most often found as a member of a
HTTP::Headers::ActionPack::MediaTypeList object.
.SH METHODS
.IX Header "METHODS"
.ie n .IP """type""" 4
.el .IP \f(CWtype\fR 4
.IX Item "type"
Accessor for the type.
.ie n .IP """major""" 4
.el .IP \f(CWmajor\fR 4
.IX Item "major"
The major portion of the media type name.
.ie n .IP """minor""" 4
.el .IP \f(CWminor\fR 4
.IX Item "minor"
The minor portion of the media type name.
.ie n .IP """matches_all""" 4
.el .IP \f(CWmatches_all\fR 4
.IX Item "matches_all"
A media type matched all if the type is \f(CW\*(C`*/*\*(C'\fR
and if it has no parameters.
.ie n .IP """equals ( $media_type | $media_type_string )""" 4
.el .IP "\f(CWequals ( $media_type | $media_type_string )\fR" 4
.IX Item "equals ( $media_type | $media_type_string )"
This will attempt to determine if the \f(CW$media_type\fR is
exactly the same as itself. If given a \f(CW$media_type_string\fR
it will parse it into an object.
.Sp
In order for two type to be equal, the types must match
exactly and the parameters much match exactly.
.ie n .IP """exact_match ( $media_type | $media_type_string )""" 4
.el .IP "\f(CWexact_match ( $media_type | $media_type_string )\fR" 4
.IX Item "exact_match ( $media_type | $media_type_string )"
This will attempt to determine if the \f(CW$media_type\fR is
a match with itself using the \f(CW\*(C`type_matches\*(C'\fR method below.
If given a \f(CW$media_type_string\fR it will parse it into an
object.
.Sp
In order for an exact match to occur it the types must
be compatible and the parameters much match exactly.
.ie n .IP """match ( $media_type | $media_type_string )""" 4
.el .IP "\f(CWmatch ( $media_type | $media_type_string )\fR" 4
.IX Item "match ( $media_type | $media_type_string )"
This will attempt to determine if the \f(CW$media_type\fR is
a match with itself using the \f(CW\*(C`type_matches\*(C'\fR method and
\&\f(CW\*(C`params_match\*(C'\fR method below. If given a \f(CW$media_type_string\fR
it will parse it into an object.
.Sp
In order for an exact match to occur it the types must
be compatible and the parameters must be a subset.
.ie n .IP """type_matches ( $media_type | $media_type_string )""" 4
.el .IP "\f(CWtype_matches ( $media_type | $media_type_string )\fR" 4
.IX Item "type_matches ( $media_type | $media_type_string )"
This will determine type compatibility, properly handling
the \f(CW\*(C`*\*(C'\fR types and major and minor elements of the type.
.ie n .IP """params_match ( $parameters )""" 4
.el .IP "\f(CWparams_match ( $parameters )\fR" 4
.IX Item "params_match ( $parameters )"
This determines if the \f(CW$parameters\fR are a subset of the
invocants parameters.
.SH AUTHOR
.IX Header "AUTHOR"
Stevan Little <stevan.little@iinteractive.com>
.SH CONTRIBUTORS
.IX Header "CONTRIBUTORS"
.IP \(bu 4
Andrew Nelson <anelson@cpan.org>
.IP \(bu 4
Dave Rolsky <autarch@urth.org>
.IP \(bu 4
Florian Ragwitz <rafl@debian.org>
.IP \(bu 4
Jesse Luehrs <doy@tozt.net>
.IP \(bu 4
Karen Etheridge <ether@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Infinity Interactive, Inc..
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.