<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/imagesize @ v0.9.0</title>
<meta name="description" content="README.md in fork/imagesize at v0.9.0.">
<meta property="og:title" content="README.md - fork/imagesize @ v0.9.0">
<meta property="og:description" content="README.md in fork/imagesize at v0.9.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="v0.9.0" data-tip="01d4f1ea66f3d6ab2e7c210f744d3f23406ae894">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/imagesize</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/imagesize</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Maid Dog</span><span class="commit-message" data-commit="01d4f1ea66f3d6ab2e7c210f744d3f23406ae894">Bump readme</span><span class="snapshot-sha sha" data-commit="01d4f1ea66f3d6ab2e7c210f744d3f23406ae894">01d4f1e</span><time datetime="2021-07-03T23:31:47-05:00" title="2021-07-03 23:31:47 -0500">2021-07-03</time></p>
<header class="topbar"><details class="switcher"><summary>v0.9.0</summary><div class="menu"><strong>branches</strong><a href="/fork/imagesize/ref/fuzz-fixes/">fuzz-fixes</a><a href="/fork/imagesize/ref/master/">master</a><strong>tags</strong><a href="/fork/imagesize/ref/v0.8.2/">v0.8.2</a><a href="/fork/imagesize/ref/v0.8.3/">v0.8.3</a><a href="/fork/imagesize/ref/v0.8.4/">v0.8.4</a><a href="/fork/imagesize/ref/v0.8.5/">v0.8.5</a><a href="/fork/imagesize/ref/v0.8.6/">v0.8.6</a><a href="/fork/imagesize/ref/v0.8.7/">v0.8.7</a><a href="/fork/imagesize/ref/v0.8.8/">v0.8.8</a><a class="current" href="/fork/imagesize/ref/v0.9.0/">v0.9.0</a><a class="all" href="/fork/imagesize/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/imagesize/">imagesize</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.6 KiB</span><span>53 lines</span></span><span class="actions"><a class="raw" href="/fork/imagesize/raw/0153f3ce13c52f489826cee7b352b0be64b17c05/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><p><a href="https://travis-ci.org/Roughsketch/imagesize"><img src="https://img.shields.io/travis/Roughsketch/imagesize.svg?style=flat-square" alt="ci-badge" /></a> <a href="https://docs.rs/imagesize"><img src="https://img.shields.io/badge/docs-online-5023dd.svg?style=flat-square" alt="docs-badge" /></a> <a href="https://crates.io/crates/imagesize"><img src="https://img.shields.io/crates/v/imagesize.svg?style=flat-square" alt="crates.io version" /></a></p>
<h1>imagesize</h1>
<p>Quickly probe the size of various image formats without reading the entire file.</p>
<p>The goal of this crate is to be able to read the dimensions of a supported image without loading unnecessary data, and without pulling in more dependencies. Most reads only require 16 bytes or less, and more complex formats take advantage of skipping junk data.</p>
<h2>Usage</h2>
<p>Add the following to your Cargo.toml:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>dependencies</a-pr><a-p>]</a-p>
<a-pr>imagesize</a-pr> <a-o>=</a-o> <a-s>&quot;0.9&quot;</a-s></pre>
<h2>Supported Image Formats</h2>
<ul>
<li>BMP</li>
<li>GIF</li>
<li>HEIC / HEIF</li>
<li>JPEG</li>
<li>JPEG XL</li>
<li>PNG</li>
<li>PSD / PSB</li>
<li>TIFF</li>
<li>WEBP</li>
</ul>
<p>If you have a format you think should be added, feel free to create an issue.</p>
<h2>Examples</h2>
<h3>From a file</h3>
<pre class="language-rust"><a-k>let</a-k> <a-p>(</a-p>width<a-p>,</a-p> height<a-p>)</a-p> = <a-k>match</a-k> <a-f>size</a-f><a-p>(</a-p><a-s>&quot;example.webp&quot;</a-s><a-p>)</a-p> <a-p>{</a-p>
    <a-cr>Ok</a-cr><a-p>(</a-p>dim<a-p>)</a-p> =&gt; <a-p>(</a-p>dim<a-p>.</a-p><a-pr>width</a-pr><a-p>,</a-p> dim<a-p>.</a-p><a-pr>height</a-pr><a-p>),</a-p>
    <a-cr>Err</a-cr><a-p>(</a-p>why<a-p>)</a-p> =&gt; <a-m>println!</a-m><a-p>(</a-p><a-s>&quot;Error getting dimensions: {:?}&quot;</a-s><a-p>,</a-p> why<a-p>)</a-p>
<a-p>}</a-p></pre>
<h3>From a vector</h3>
<p>Where <code>magic_partial_download</code> is a function that downloads a specified amount of bytes from a given url.</p>
<pre class="language-rust"><a-k>let</a-k> data<a-p>:</a-p> <a-t>Vec</a-t><a-p>&lt;</a-p><a-t>u8</a-t><a-p>&gt;</a-p> = <a-f>magic_partial_download</a-f><a-p>(</a-p><a-s>&quot;http://example.com/example.jpg&quot;</a-s><a-p>,</a-p> <a-co>0x200</a-co><a-p>);</a-p>
<a-k>let</a-k> <a-p>(</a-p>width<a-p>,</a-p> height<a-p>)</a-p> = <a-k>match</a-k> <a-f>blob_size</a-f><a-p>(</a-p><a-o>&amp;</a-o>data<a-p>)</a-p> <a-p>{</a-p>
    <a-cr>Ok</a-cr><a-p>(</a-p>dim<a-p>)</a-p> =&gt; <a-p>(</a-p>dim<a-p>.</a-p><a-pr>width</a-pr><a-p>,</a-p> dim<a-p>.</a-p><a-pr>height</a-pr><a-p>),</a-p>
    <a-cr>Err</a-cr><a-p>(</a-p>why<a-p>)</a-p> =&gt; <a-m>println!</a-m><a-p>(</a-p><a-s>&quot;Error getting dimensions: {:?}&quot;</a-s><a-p>,</a-p> why<a-p>)</a-p>
<a-p>}</a-p></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text">[![ci-badge][]][ci] [![docs-badge][]][docs] [![crates.io version]][crates.io link]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>#</a-p> <a-tt>imagesize</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">Quickly probe the size of various image formats without reading the entire file.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">The goal of this crate is to be able to read the dimensions of a supported image without loading unnecessary data, and without pulling in more dependencies. Most reads only require 16 bytes or less, and more complex formats take advantage of skipping junk data.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>##</a-p> <a-tt>Usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">Add the following to your Cargo.toml:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>[</a-p><a-pr>dependencies</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>imagesize </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0.9&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>## </a-p><a-tt>Supported Image Formats</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>* BMP</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>* GIF</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>* HEIC / HEIF</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>* JPEG</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>* JPEG XL</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>* PNG</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>* PSD / PSB</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>* TIFF</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>* WEBP</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>If you have a format you think should be added, feel free to create an issue.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>## </a-p><a-tt>Examples</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>### </a-p><a-tt>From a file</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>let (width, height) = </a-p><a-k>match</a-k><a-p> </a-p><a-f>size</a-f><a-p>(</a-p><a-s>&quot;example.webp&quot;</a-s><a-p>) {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>    </a-p><a-cr>Ok</a-cr><a-p>(dim) =&gt; (dim.</a-p><a-pr>width</a-pr><a-p>, dim.</a-p><a-pr>height</a-pr><a-p>),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>    </a-p><a-cr>Err</a-cr><a-p>(why) =&gt; </a-p><a-m>println!</a-m><a-p>(</a-p><a-s>&quot;Error getting dimensions: {:?}&quot;</a-s><a-p>, why)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>### </a-p><a-tt>From a vector</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>Where `magic_partial_download` is a function that downloads a specified amount of bytes from a given url.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>let data: </a-p><a-t>Vec</a-t><a-p>&lt;</a-p><a-t>u8</a-t><a-p>&gt; = </a-p><a-f>magic_partial_download</a-f><a-p>(</a-p><a-s>&quot;http://example.com/example.jpg&quot;</a-s><a-p>, </a-p><a-co>0x200</a-co><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>let (width, height) = </a-p><a-k>match</a-k><a-p> </a-p><a-f>blob_size</a-f><a-p>(</a-p><a-o>&amp;</a-o><a-p>data) {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>    </a-p><a-cr>Ok</a-cr><a-p>(dim) =&gt; (dim.</a-p><a-pr>width</a-pr><a-p>, dim.</a-p><a-pr>height</a-pr><a-p>),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>    </a-p><a-cr>Err</a-cr><a-p>(why) =&gt; </a-p><a-m>println!</a-m><a-p>(</a-p><a-s>&quot;Error getting dimensions: {:?}&quot;</a-s><a-p>, why)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-tu>[ci]</a-tu><a-p>: </a-p><a-tu>https://travis-ci.org/Roughsketch/imagesize</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-tu>[ci-badge]</a-tu><a-p>: </a-p><a-tu>https://img.shields.io/travis/Roughsketch/imagesize.svg?style=flat-square</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-tu>[crates.io link]</a-tu><a-p>: </a-p><a-tu>https://crates.io/crates/imagesize</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-tu>[crates.io version]</a-tu><a-p>: </a-p><a-tu>https://img.shields.io/crates/v/imagesize.svg?style=flat-square</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-tu>[docs]</a-tu><a-p>: </a-p><a-tu>https://docs.rs/imagesize</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-tu>[docs-badge]</a-tu><a-p>: </a-p><a-tu>https://img.shields.io/badge/docs-online-5023dd.svg?style=flat-square</a-tu></span></span></pre></div></div>
</main>
</body>
</html>
